程序员为什么还要刷题 styleguide:我们如何编写代码
程序员常刷题
-
源代码布局
-
使用 UTF-8 作为源文件编码。每个缩进级别使用两个空格,没有制表符。
-
不留下任何类型的尾随空格。
-
不要在文件底部留空行。
-
使用 Unix 风格的行尾。(*BSD/Solaris/Linux/OSX用户默认被覆盖,Windows用户必须格外小心。)
-
保持行宽不超过 94 个字符。
-
注释编写
-
自文档化代码。如果觉得需要评论,请重构代码,直到评论感觉有点矫枉过正。
-
然后,忽略本节的其余部分。长于单词的注释大写并使用标点符号。
-
避免多余的评论。
-
不良示例:
counter += 1 # increments counter by one
-
保持现有评论最新。一个过时的评论比没有评论更糟糕。
-
避免写注释来解释糟糕的代码。重构代码以使其不言自明。
-
避免代码横幅。如果您需要它们,您的类可能太大了。重构!
-
代码横幅是一种代码味道