zoukankan      html  css  js  c++  java
  • 代码规范

    作业要求参见[https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147]

    结对同学:王硕

    具体条款如下:

    1.所有的单行注释用‘//’并跟在代码上方。

    2.给关键代码加注释,修改代码时应同时修改相应的注释,保证注释与代码的一致性。

    3.每次测试之后要删除无用代码。

    4.变量命名方式采用匈牙利命名法。

    5.增加代码的易读性,对于很长的单行代码,另起一行,规范排版。

    6.定义的变量名过长时,适当缩写,但可以被识别出原单词含义。

    7.捕捉异常时利用try对用户进行友好的反馈。

    8.大括号应单独占一行,并有相应的大括号在同一列对齐。

    9.所有的操作符前后加空格。

    10.“变量名、函数名,都只敲一遍,以后全部是拷贝+粘贴。”——拷贝+粘贴 

    执行和违反情况

    如表:(注:W代指王硕,Z代指赵佳璐)

    代码规范约定

    规范执行情况

    规则是否有效/是否进行更改

    所有的单行注释用‘//’并跟在代码上方

    W触发3次,习惯性写在代码后面

    规则有效,无更改

    给关键代码加注释,修改代码时应同时修改相应的注释,保证注释与代码的一致性

    同时触发多次,时常忘记及时修改注释

    规则有效,无更改

    每次测试之后要删除无用代码

    Z触发2次,W触发3次

    规则有效,无更改

    变量命名方式采用匈牙利命名法。

    Z触发7次,不熟悉命名规则

    弱化规则,更改为变量含义对应的英文单词

    增加代码的易读性,对于很长的单行代码,另起一行,规范排版。

    W触发2次,Z触发1次

    规则有效,无更改

    定义的变量名过长时,适当缩写,但可以被识别出原单词含义。

    Z触发4次

    规则有效,无更改

    捕捉异常时利用try对用户进行友好的反馈。

    W触发3次

    规则有效,无更改

    大括号应单独占一行,并有相应的大括号在同一列对齐。

    W触发1次

    强化规则,为增加美观性和代码可读性,大括号对应的if、while和for等也另起一行。

    所有的操作符前后加空格。

    同时触发多次

    规则有效,无更改

    变量名、函数名,都只敲一遍,以后全部是拷贝+粘贴。

    Z触发3次,经常打错名字造成bug

    规则有效,无更改

    三、代码规范总结

      1.第一次进行结对编程。彼此的编程习惯还存在一些差异,需要磨合和统一。

      2.相关代码的注释可以让彼此更能理解对方的想法。

      3.变量和方法名的定义要有一定意义,不能随意定义。

  • 相关阅读:
    Unix命令大全
    vs2008 与 IE8出现的兼容性问题
    Java 创建文件、文件夹以及临时文件
    如何修改Wamp中mysql默认空密码
    PAT 乙级真题 1003.数素数
    Tags support in htmlText flash as3
    DelphiXE4 FireMonkey 试玩记录,开发IOS应用 还是移植
    10 Great iphone App Review sites to Promote your Apps!
    HTML tags in textfield
    Delphi XE4 IOS 开发, "No eligible applications were found“
  • 原文地址:https://www.cnblogs.com/zhaojialu/p/9720892.html
Copyright © 2011-2022 走看看