zoukankan      html  css  js  c++  java
  • 20190919-5 代码规范,结对要求

    此作业要求参见:https://edu.cnblogs.com/campus/nenu/2019fall/homework/7630

    结对伙伴:王志文

    要求1 《代码规范》包括10项条款。制定条款的目的是在程序设计的过程中(触犯和)约束代码风格,希望切实可行,容易观察和客观检验。

    根据本次结对编程所的经验以及我们所犯的错误,我与贺敬文同学总结定义了以下代码规范:

    1、格式:

    1). 每个函数的行数不能大于60行。

    2). 操作符左右各加一个空格,不要为了对齐增加空格。

    3). 函数定义之间空两行,函数内逻辑无关段落之间空一行,其他地方尽量不要再空行。

    4). if/for/while语句中,即使执行语句只有一句,也必须另起一行。 

    5). 单行代码很长,不能一次性映入眼帘,则另起一行,规范排版。

    6). 缩进:4个空格的缩进(编辑器都可以完成此功能,默认为pycharm的自动缩进),不要使用Tap,更不能混合使用Tap和空格。

    7). 变量的声明尽量集中在一起。与功能语句用空行分开。

    2、命名:

    8). 变量和函数的命名使用具有其功能含义的英文单词或词组简写。

    9). 函数命名使用全部小写的方式,可以使用下划线。。

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

    3、注释:

    11).行注释:在一句代码后加注释。“#”号后空一格,段落间用空行分开。尽量避免无意义的注释。

    要求2 记录完成本周作业过程中,《代码风格规范》执行情况。包括记录每一条规则的违反和纠正、次数,规范中某项条款的增强、消弱、或废除。

    条款 违反和纠正情况 条款变动情况
    1 违反1次,转换逆波兰表达式函数代码过长 减弱规则,由60行变为70行
    2 违反17次,已纠正 规则有效,无更改
    3 函数逻辑不清,多次忘记空行 弱化规则,变量定义和功能实现空一行
    4 无违反 规则有效,无更改
    5 无违反 规则有效,无更改
    6 由于Python中if 和else 的语句缩进要自行控制。共违反20次,互相提醒都已纠正。 规则有效,无更改
    7 违反5次,3次变量名忘记集中定义,2次忘记使用空行隔开 规则有效,无更改
    8 违反9次,3个函数,6个变量名用的拼音 规则有效,无更改
    9 无违反 规则有效,无更改
    10 规则无效
    11 违反2次,#后忘记空格 规则有效,无更改
  • 相关阅读:
    在Centos 7下编译openwrt+njit-client
    开博随笔
    Chapter 6. Statements
    Chapter 4. Arrays and Pointers
    Chapter 3. Library Types
    Chapter 2.  Variables and Basic Types
    关于stm32不常用的中断,如何添加, 比如timer10 timer11等
    keil 报错 expected an identifier
    案例分析 串口的地不要接到电源上 会烧掉
    案例分析 CAN OPEN 调试记录 进度
  • 原文地址:https://www.cnblogs.com/hejw031/p/11579498.html
Copyright © 2011-2022 走看看