编程规范
土豆吞噬者
这个作者很懒,什么都没留下…
展开
-
代码命名规范
有意义的命名 代码中的命名应该名副其实,使人一眼看上去就知道是它们为什么存在,做什么事,应该怎么用,如果需要注释来补充,就不算是名副其实,一旦你发现有更好的名称就应该换掉旧的名称。 代码中的命名应该避免误导,应当避免使用与本意相悖的词,例如使用bookList来表示一组书籍,除非它真的是List类型,否则会引起错误的判断,这个时候使用bookGroup或books更好。 代码中的命名应该做有意义...原创 2019-08-15 22:51:38 · 2318 阅读 · 0 评论 -
函数规范
函数要尽可能的短小,最好不要超过20行。 函数应该只做一件事,如果函数只是做了函数名下同一抽象层上的步骤,则函数还是只做了一件事。如果函数还能再拆出一个函数,说明这个函数不止做了一件事,被拆出的函数不仅只是单纯地重新诠释其实现,而是又生成了另外一个抽象层。 函数中的语句最好在同一抽象级上,而不是既有高等抽象概念(例如调用封装好的接口),又有低等抽象概念(例如直接操作数据)。 ...原创 2019-08-25 21:29:41 · 751 阅读 · 0 评论 -
注释规范
注释的作用是弥补我们在用代码表达意图时遭遇的失败,如果你发现自己需要写注释,说明你的代码的表达能力不够,这个时候应该想下能否使用更好的代码来表达。 代码在变动,但是注释不总是随之变动,随着时间的流逝,注释常常用其所描述的代码分隔开来,越来越不准确,与其把精力放在维护注释上还不如把力气用在写清楚代码。 不准确的注释不如没注释,只有代码能忠实地告诉你它做的事,所以,尽管有时候也需要注释,我们也应该多花...原创 2019-08-26 23:38:09 · 324 阅读 · 0 评论