• 第四周作业一_代码规范


     结伴同学:王超

    经过我和队友的讨论,我们的代码规范包含命名、注释和格式三部分。

    一、命名规范

      1.命名约定(camelCasing)

      包含一到多个单词,第一个单词首字母小写,其余单词首字母大写。例如:name、productId、userName、helloWorld等。

      2.命名选择

      选择意义单一明确的名字,在命名时要使用专业的单词,避免使用“空洞”的单词与拼音。标识符名字必须要表达出该标识符的意义,绝对不可以使用无意义的v1,v2…vn之类的命名。例如:userNum 用户编号。

    二、注释规范

      1.注释必须使用中文及中文的标点符号

      2.变量注释

      重要的变量在命名变量时后面加//单行注释。例如:int addNum; //加数

      3.类属性注释

      在类的属性必须以以下格式编写属性注释:   

      /// <summary>    

      ///属性说明

      /// </summary>

      4.解释行数小于等于两行时,使用//注释。

      5.解释行数大于两行小于十行时,使用 /*多行注释1

                         多行注释2

                         多行注释3*/

    三、格式规范

      1.代码的缩进用Tab,而不要用space,Tab缩进=4个空格。

      2. 方法与方法之间有两个空行  

      3.大括号"{"要新起一行。

      正确编写: 

      public class clsLogin 

      {

      }   

      错误编写: 

      public class clsLogin{

                }

      4.始终使用"{ }"包含if/else下的语句,即使只有一条语句。

      正确编写:

      if (true)

      { 

        //语句。          

      }

      错误编写:

      if(true) 

      //语句。

    要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。在编码过程中完全未被违反的条款,说明过于宽松,或你们已经完全"本能"反应,不应作为条款,在本要求及要求1中不得分。此种情况,应补充一条新的条款。 (20分)

    1.命名约定(camelCasing):编码过程中严格执行,故此规范有效,无需更改。

    2.命名选择:编码过程中严格执行,故此规范有效,无需更改。

    3.注释必须使用中文及中文的标点符号:编码过程中严格执行,故此规范有效,无需更改。

    4.变量注释:编码过程中严格执行,故此规范有效,无需更改。

    5.类属性注释:编码过程中严格执行,故此规范有效,无需更改。

    6.解释行数小于等于两行时,使用//注释:编码过程中严格执行,故此规范有效,无需更改。

    7.解释行数大于两行小于十行时,使用多行注释:编码过程中严格执行,故此规范有效,无需更改。

    8.代码的缩进用Tab:编码前期多次忘记此规则,互相提醒后,习惯并改正,故此规范有效,无需更改。

    9. 方法与方法之间有两个空行:编码过程中两次忘记此规则,在检查过程中发现并及时改正,故此规范有效,无需更改。

    10.大括号"{"要新起一行:编码过程中四次忘记此规则,在检查过程中发现并及时改正,故此规范有效,无需更改。

     

  • 相关阅读:
    Network Flows(借助ortools)
    【转】一张图看懂IaaS, PaaS和SaaS的区别
    论文中的一些符号 O(big-Oh) Ω(big-omega) Θ(big-theta)
    最大流问题
    4 Mininet测量路径的损耗率
    3 Mininet命令延伸实验拓展
    2 Mininet可视化应用
    快速定位问题
    软中断与软中断的排查
    系统出现大量不可中断进程与僵尸进程
  • 原文地址:https://www.cnblogs.com/lynlyn/p/7646552.html
Copyright © 2020-2023  润新知