google文档.pdf

8. 格式 代码风格和格式确实比较随意, 但一个项目中所有人遵循同一风格是非常容易的. 个体未必同意下述每一处格式规 则, 但整个项目服从统一的编程风格是很重要的, 只有这样才能让所有人能很轻松的阅读和理解代码. 另外, 我们写了一个 emacs 配置文件 来帮助你正确的格式化代码. 8.1. 行长度 T i 每一行代码字符数不超过 80. 我们也认识到这条规则是有争议的, 但很多已有代码都已经遵照这一规则, 我们感觉一致性更重要. 优点: 提倡该原则的人主张强迫他们调整编辑器窗口大小很野. 很多人同时并排开几个代码窗口, 根本没有多余空 间拉伸窗口. 大家都把窗口最大尺寸加以限定, 并且 80 列宽是传统标准. 为什么要改变呢? 缺点: 反对该原则的人则认为更宽的代码行更易阅读. 80 列的限制是上个世纪 60 年代的大型机的古板缺陷; 现代设 备具有更宽的显示屏, 很轻松的可以显示更多代码. 结论: 80 个字符是最大值. 特例: 如果一行注释包含了超过 80 字符的命令或 URL, 出于复制粘贴的方便允许该行超过 80 字符. 包含长路径的 # i n c l u d e 语句可以超出80列. 但应该尽量避免. 头文件保护 可以无视该原则. 8.2. ASCII 字符 T i 尽量不使用非 ASCII 字符, 使用时必须使用 UTF-8 编码. 即使是英文, 也不应将用户界面的文本硬编码到源代码中, 因此非 ASCII 字符要少用. 特殊情况下可以适当包含此类 字符. 如, 代码分析外部数据文件时, 可以适当硬编码数据文件中作为分隔符的非 ASCII 字符串; 更常见的是 (不需 要本地化的) 单元测试代码可能包含非 ASCII 字符串. 此类情况下, 应使用 UTF-8 编码, 因为很多工具都可以理解 和处理 UTF-8 编码. 十六进制编码也可以, 能增强可读性的情况下尤其鼓励 比如 \ x E F \ x B B \ x B F 在 Unicode 中是 宽度无间断 的间隔符号, 如果不用十六进制直接放在 UTF-8 格式的源文件中, 是看不到的. (yospaly 注: \ x E F \ x B B \ x B F 通常用作 UTF-8 w ith BOM 编码标记) 8.3. 空格还是制表位 T i 只使用空格, 每次缩进 2 个空格. 我们使用空格缩进. 不要在代码中使用制符表. 你应该设置编辑器将制符表转为空格. 8.4. 函数声明与定义 T i 返回类型和函数名在同一行, 参数也尽量放在同一行. 函数看上去像这样: R e t u r n T y p e C l a s s N a m e : : F u n c t i o n N a m e ( T y p e p a r _ n a m e , T y p e p a r _ n a m e ) { D o S o m e t h i n g ( ) ; . . . } 如果同行文本太多, 放不下所有参数: R e t u r n T y p e C l a s s N a m e : : R e a l l y L o n g F u n c t i o n N a m e ( T y p e p a r _ n a m e 1 , T y p e p a r _ n a m e 2 ,