• 20200924-4 代码规范,结对要求


    参见教材第68页至第78页,2人结对编写《代码规范》,并在本周作业中遵循。

     结对编程伙伴:思得 李思源

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

    1. 缩进

    统一使用4个空格进行缩进。Python对缩进极其严格,tab如果没有在编辑器设置成4个空格的话与空格混用会报错。

    2.空行

    a) 模块级函数和类定义之间空两行;

    b) 类成员函数之间空一行。

    3.函数的参数列表

    a) 函数的参数列表中’,’逗号之后要有空格;

    b) 函数的参数列表中,默认值等号两边不要添加空格;

    c) 左括号之后,右括号之前不要加多余的空格;

    4.注释

    a) 功能开头前使用注释描述功能作用

    b) 一些关键代码使用注释描述关键代码作用

    5.文件名

    文件名使用帕斯卡命名法风格。

    6、分号

    不要在行尾加分号,也不要用分号将两条命令放在同一行。

    7、函数和属性命名

    a) 函数名函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_user_name。

    b) 方法的命名使用驼峰法,例如 getUserName

    c) 属性的命名使用驼峰法,例如 tableNameinstance

    8、行宽 

    每行代码尽量不超过 80 个字符。

    a)如果此行带注释可以超过80字符,但不超过120个。

    b)特别长的函数调用可以超过80字符。

    9、变量名

    变量名采用蛇形命名法风格,字母全小写。

    10、常量名(废除,未使用常量)

    常量名采用蛇形命名法风格,字母全大写。

    11、括号(补充新条款)

    在复杂的条件表达式中,用括号可以很清楚的表示逻辑优先级。

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

    规则 违规情况 变动情况
    1 李思源违规3次,李虎违规1次,均提醒改正 规则有效,不变动
    2 李思源违规2次,李虎违反1次,均提醒改正 规则有效,不变动
    3 李思源违规13次,李虎违规2次,均提醒改正 规则有效,不变动,因为不熟悉python,无需削弱
    4 李思源违规1次,李虎违规1次,均提醒改正 规则有效,不变动
    5 李思源违规1次,李虎违规0次,已提醒改正 规则有效,不变动
    6 李思源违规15次,李虎违规2次,均提醒改正 规则有效,不变动,因为不熟悉python,无需削弱
    7 李思源违规4次,李虎违规0次,已提醒改正 规则有效,不变动
    8 李思源违规1次,李虎违规1次,均提醒改正 添加几个特别情况,规则有效
    9 李思源违规5次,李虎违规1次,均提醒改正 规则有效,不变动
    10 规则废除,未使用常量
    11 李思源违规3次,李虎违规1次,均提醒改正 规则有效,不变动
  • 相关阅读:
    Leetcode: Plus One Linked List
    Leetcode: Sort Transformed Array
    Leetcode: Rearrange String k Distance Apart
    Leetcode: Line Reflection
    Leetcode: Logger Rate Limiter
    Leetcode: Design Snake Game
    Leetcode: Android Unlock Patterns
    Leetcode: Longest Substring with At Most K Distinct Characters && Summary: Window做法两种思路总结
    Design Tic-Tac Toe
    Leetcode: Moving Average from Data Stream
  • 原文地址:https://www.cnblogs.com/lhbat/p/13763487.html
Copyright © 2020-2023  润新知