# 54.1.
格式化源代码格式使用 4 列制表符间距,保留制表符(即制表符不扩展为空格)。
每个逻辑缩进级别是一个额外的制表位。布局规则(大括号定位等)遵循 BSD 约定。特别是,用于控制块的花括号
如果,
尽管,
转变
等各走各的路。限制行长,以便代码在 80 列的窗口中可读。(这并不意味着您永远不能超过 80 列。例如,为了将代码保持在 80 列内而在任意位置打破长错误消息字符串可能不会增加可读性。)
为了保持一致的编码风格,不要使用 C++ 风格的注释(//
注释)。pgindent 将替换为/* ... */
.
多行注释块的首选样式是
/*
* comment text begins here
* and continues here
*/
请注意,从第 1 列开始的注释块将由 pgindent 原样保留,但它将重新排列缩进的注释块,就好像它们是纯文本一样。如果要在缩进块中保留换行符,请添加如下破折号:
/*----------
* comment text begins here
* and continues here
*----------
*/
虽然提交的补丁不一定要遵循这些格式规则,但这样做是个好主意。您的代码将在下一个版本之前通过 pgindent 运行,因此在其他一些格式约定下让它看起来很好是没有意义的。补丁的一个好的经验法则是“使新代码看起来像它周围的现有代码”。
这源/工具
目录包含可与 emacs、xemacs 或 vim 编辑器一起使用的示例设置文件,以帮助确保它们根据这些约定格式化代码。
越来越少的文本浏览工具可以调用为:
more -x4
less -x4
使它们适当地显示选项卡。