MicroTeam 代码规范注意事项

        移山之道中说得好,写代码和打麻将不同,打麻将可以乱摆,让别人看不清自己牌路,但是代码不同,是需要人看的,一个统一的代码风格有助于提高大家理解代码的效率,增加代码的强壮性,下面是我建议的一个代码规范标准,希望大家在写team projecct的程序代码时可以遵守。(大部分参考《移山之道》)

         1.缩进  Tab 4个空格

     2.一个逻辑最好写一行,便于调试,例如: if (condition)   DoSomething();应该写成:

                   if (condition)

       {

          DoSomething();

                   }

         3.不要节省{}的使用,例如上例,虽然只有if中只有一句,但是请加上{}

         4.命名标准:

                (a)变量名:

                               对于局部变量:第一个字母小写,从第二个单词开始,每个单词的首字母大写。

                                        例如:int  myDocument;

                               对于全局变量(或者说类变量):以下划线开头,从第一个单词开始,每个单词第一个字母大写

                                        例如:int  _MyDocument;

                 (b) 属性名:

                              从第一个单词开始每个单词首字母大写,

                                        例如:  int  MyDocument

                  {

                    get;

                  }

                (c)函数名:

                             从第一个单词开始每个单词首字母大写,命名中最好包含动词。

                                        例如: public void PrintMyDocument();

                 (d) 类名:

                             从第一个单词开始每个单词首字母大写。

                 (e)接口名:

                             以I开头,后面的每个单词首字母大写。  

        5.函数与函数之间至少空一行,不要多过3行

        6.注释:

               只用来解释程序做什么,为什么这样做,以及要特别注意的地方做就行了。至于怎

               么做,应该由代码来解释。

        7.对于结构性较强的部分,可以用  #region  ,#endregion  加以括起来,同时加以

              注释,例如:

                            #region    selection  sort algorithm

                                  。

                                  。

                                  。

                            #endregion                

   

         好,今天就写这么多规范,如果有补充请尽快回复,谢谢您的支持!:),希望MicroTeam的队员们,如果参与代码的开发,请尽量遵守上面的规范。谢谢合作!O(^_^)O      

 

MicroTeam  Liuhang          

原文地址:https://www.cnblogs.com/MicroTeam/p/1915813.html