不拘泥于小节又名了解那些东西不应该标准化
原则:只规定需要规定的事情,不要强制施加个人洗好或者过时的做法
应该在每个源文件乃至每个项目中都使用一致的格式,因为同一段代码中要在集中编程风格直接换来换去是很不舒服的。但是无需在多个项目或者整个公司范围内强制实施一致的格式。几种常见的情况如:
- 不要规定缩进多少,应该规定要用缩进来体现代码的结构。
缩进空格的数量可以遵照个人习惯,但是至少在每个文件中应该保持一致。
- 不要强制行的具体长度,应该保证代码行的长度有利于阅读。
可以遵照个人习惯来决定行长,但是不要过长。研究表明,文字长度不超过10个单词最有利于阅读。
- 不要在命名方面规定过多,应该规定的是使用一致的命名规范。
有两点是必须的:(1)永远不要使用“晦涩的名称”,即以下划线开始或者包含双下划线的名称;(2)总是使用形如ONLY_UPPERCASE-NAMES的全大写字母表示宏,不要考虑使用常见的词或者缩略词作为宏的名称。
- 不要规定注释风格(除非需要使用工具从特定的体例中提取出文档)。
应该编写有用的注释,尽可能编写代码而不是写注释,不要在注释中出现重复写代码语义,这样很容易产生不一致。应该编写的是解释方法和原理的说明性注释。
时间: 2024-12-21 22:03:50