格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化,这对于您和必须解密源代码的其他开发人员都有帮助。
以下几点是推荐的格式化方法。
- 建立标准的缩进大小(如四个空格),并一致地使用此标准。用规定的缩进对齐代码节。
- 在发布源代码的硬拷贝版本时使用 monotype 字体。
- 在括号对对齐的位置垂直对齐左括号和右括号,如:
< ... { i++) 100; < i (i="0;">
还可以使用倾斜样式,即左括号出现在行尾,右括号出现在行首,如:
< ... 100; < i (i="0;" i++){>
无论选择哪种样式,请在整个源代码中使用那个样式。
- 沿逻辑结构行缩进代码。没有缩进,代码将变得难以理解,如:
< End Else If Then>
缩进代码会产生出更容易阅读的代码,如:
< End Else If Then>
- 为注释和代码建立最大的行长度,以避免不得不滚动源代码编辑器,并且可以提供整齐的硬拷贝表示形式。
- 在大多数运算符之前和之后使用空格,这样做时不会改变代码的意图。但是,C++ 中使用的指针表示法是一个例外。
- 使用空白为源代码提供结构线索。这样做会创建代码“段”,有助于读者理解软件的逻辑分段。
- 当一行被分为几行时,通过将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。
- 只要合适,每一行上放置的语句避免超过一条。例外是 C、C++、C# 或 JScript 中的循环,如 for (i = 0; i < 100; i++)。
- 编写 HTML 时,建立标准的标记和属性格式,如所有标记都大写或所有属性都小写。另一种方法是,坚持 XHTML 规范以确保所有 HTML 文档都有效。尽管在创建 Web 页时需折中考虑文件大小,但应使用带引号的属性值和结束标记以方便维护。
- 编写 SQL 语句时,对于关键字使用全部大写,对于数据库元素(如表、列和视图)使用大小写混合。
- 在物理文件之间在逻辑上划分源代码。
- 将每个主要的 SQL 子句放在不同的行上,这样更容易阅读和编辑语句,例如:
< State="WA" WHERE Customers FROM LastName FirstName,>
- 将大的复杂代码节分为较小的、易于理解的模块。
- 沿逻辑结构行缩进代码。没有缩进,代码将变得难以理解,如: