源代码格式设置使用 4 列制表符间距,且保留制表符(即,不将制表符扩展为空格)。每个逻辑缩进级别是一个其他制表符停止点。
布局规则(大括号定位等)遵循 BSD 约定。特别是,if
、while
、switch
等受控块的花括号位于它们自己的行上。
将代码行限制在 80 列的窗口中以提高可读性。(不代表你绝不能超过 80 列。例如,在任意位置中断一个长得错误消息字符串以将代码限制在 80 列内可能不会提升可读性。)
为了保持一致的编码风格,不要使用 C++ 风格注释(//
注释)。pgindent 将用 /* ... */
替换这些注释。
多行注释块的首选风格是
/* * comment text begins here * and continues here */
请注意,从第 1 列开始的注释块将被 pgindent 原样保留,但它会对缩进的注释块以纯文本形式重新进行流设置。如果你想保留缩进块中的换行符,请像这样添加破折号
/*---------- * comment text begins here * and continues here *---------- */
虽然提交的补丁绝对不必遵循这些格式化规则,但这样做会是个好主意。你的代码在下一个版本发布之前会通过 pgindent 运行,因此让你的代码在其他一些格式化约定下看起来不错毫无意义。一个关于补丁的不错经验法则就是 “让新代码看起来与它周围的现有代码一样”。
src/tools/editors
目录包含可与 Emacs、xemacs 或 vim 编辑器搭配使用的示例设置文件,以帮助确保这些编辑器根据这些约定对代码进行格式化。
如果你想在本地运行 pgindent 以帮助你的代码与项目风格相匹配,请参阅 src/tools/pgindent
目录。
文本浏览工具 more 和 less 可以如下调用
more -x4 less -x4
以使它们恰当地显示标签页。