c#书写规范之---代码书写规范

 

代码书写规范

         格式化使代码的逻辑结构很明显。花时间确保源代码以一致的逻辑方式进行格式化，这对于您和你的开发小组，以及以后维护源代码的其他开发人员都有很大的帮助。

以下几点是推荐的格式化方法。

• 建立标准的缩进大小（如四个空格），并一致地使用此标准。用规定的缩进对齐代码节。
• 在发布源代码的硬拷贝版本时使用特定的字体以及字号（新宋体、小五号）。
• 在括号对对齐的位置垂直对齐左括号和右括号，如：

      for (i = 0; i < 100; i++)

      {

           ;              

      }

也可以使用倾斜样式，即左括号出现在行尾，右括号出现在行首，如：

      for (i = 0; i < 100; i++){

;

   }

无论选择哪种样式，请在整个源代码中使用那个样式。

• 沿逻辑结构行缩进代码。没有缩进，代码将变得难以理解，如：

              if(expression )

              {

                   //

                   //此处填写你的代码块;

                   //

              }

 

              if(expression )

              {

                   //

                   //此处填写你的代码块;

                   //

              }

              else

              {

                   //

                   //此处填写你的代码块;

                   //

              }

缩进代码会产生出更容易阅读的代码，如：

if(expression )

       {

              if(expression )

              {

                   //

                   //此处填写你的代码块;

                   //

              }

              else

              {

                   //

                   //此处填写你的代码块;

                   //

              }

                    }

• 为注释和代码建立最大的行长度，以避免不得不滚动源代码编辑器，并且可以提供整齐的硬拷贝表示形式。
• 在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图。但是，C++ 中使用的指针表示法是一个例外。
• 使用空白为源代码提供结构线索。这样做会创建代码“段”，有助于读者理解软件的逻辑分段。
• 当一行内容太长而必须换行时，在后面换行代码中要使用缩进格式，如下：

string inserString = "Insert Into TableName(username,password,email,sex,address)"

+ "Values('Soholife','chenyp','soholife@sina.com','male','深圳福田')";

 

• 只要合适，每一行上放置的语句避免超过一条。例外是 C、C++、C# 或 JScript 中的循环，如 for (i = 0; i < 100; i++)。
• 编写 HTML 时，建立标准的标记和属性格式，如所有标记都大写或所有属性都小写。另一种方法是，坚持 XHTML 规范以确保所有 HTML 文档都有效。尽管在创建 Web 页时需折中考虑文件大小，但应使用带引号的属性值和结束标记以方便维护。
• 编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。
• 在物理文件之间在逻辑上划分源代码。
• 将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如：

      SELECT FirstName, LastName

      FROM Customers

          WHERE State = 'WA'

将大的复杂代码段分为较小的、易于理解的模块。