时间:2021-05-23
写出自解释文档代码,然后让这部分歇息吧。这不是说着玩。
使用英文编写注释。
使用一个空格将注释与符号隔开。
注释超过一个单词了,应句首大写并使用标点符号。句号后使用 一个空格
避免多余的注释。
# bad counter += 1 # increments counter by one随时更新注释,没有注释比过期的注释更好。
不要为糟糕的代码写注释。重构它们,使它们能够“自解释”。(Do or do not - there is no try.)
注解应该写在紧接相关代码的上方。
注解关键字后跟一个冒号和空格,然后是描述问题的记录。
如果需要多行来描述问题,随后的行需要在 # 后面缩进两个空格。
def bar # FIXME: This has crashed occasionally since v3.2.1. It may # be related to the BarBazUtil upgrade. baz(:quux) end如果问题相当明显,那么任何文档就多余了,注解也可以(违规的)在行尾而没有任何备注。这种用法不应当在一般情况下使用,也不应该是一个 rule。
def bar sleep 100 # OPTIMIZE end使用 TODO 来备注缺失的特性或者在以后添加的功能。
使用 FIXME 来备注有问题需要修复的代码。
使用 OPTIMIZE 来备注慢的或者低效的可能引起性能问题的代码。
使用 HACK 来备注那些使用问题代码的地方可能需要重构。
使用 REVIEW 来备注那些需要反复查看确认工作正常的代码。例如: REVIEW: 你确定客户端是怎样正确的完成 X 的吗?
使用其他自定义的关键字如果认为它是合适的,但是确保在你的项目的 README 或者类似的地方注明。
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
怎么做网站?个人怎么做网站?需要注意什么事项呢?对于进行网站建设的时候,需要多加注意其中的一些问题,有一些问题,如果是处理不当的情况下,就会直接造成整个网站
网站建设中最基础的就是HTML代码,也是每个网站制作人员需要熟练掌握的技能。除此之外还需要注意一些网站制作的基本问题,第一是网站北京颜色,需要在编写代码时注意白
手机怎么建站?手机建站要注意什么?很多人在建站时都会遇到这样的问题,目前手机建站比较少,大多数都是使用网页建站。不过手机建站有自己的优势特点,也需要注意一些问题
当设计公司的官方网站时,确实有一些地方需要注意,如果你没有注意到,可能会有一些问题。目前,许多企业还没有对这些问题给予足够的重视。为了使公司官方网站的效果非常好
一个企业网站在经过一段时间运营之后,就会或多或少出现一些问题,这个时候就需要改版了。那么企业网站在改版的时候要注意一些问题,包括改版的原因,网站改版的目标,改版