• RATE-代码规范、冲刺任务与计划


    编码规约

    缩进与空格

    • 缩进采用空格缩进,规定缩进采用4个空格
    • 在eclipse中,必须勾选insert spaces for tabs
    • 运算符的左右必须有一个空格
    • 左大括号前加空格且不换行;左大括号后换行
    • 右大括号前换行,右大括号后有else,也换行
    • 避免一行的长度超过60个字符

    各类命名

    类命名

    • 采用UpperCamelCase风格
    • 严禁使用拼音与英文混合的方式
    • 采用驼峰形式 XmlService

    方法、参数、成员、局部变量命名

    • lowerCamelCase风格
    • 严禁使用拼音与英文混合的方式
    • 采用驼峰形式
    • 方法尽量采用动词或判断型词汇

    函数最大行数

    • 规定函数最大行数不超过一屏,大约40行

    常量问题

    • long或者Long初始赋值时,必须使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解
    • 常量命名一律用大写,单词间用下划线隔开

    空行规则

    • 在不同类、方法间添加空行

    注释规则

    • 类和方法采用/* 内容*/格式进行注释
    • 方法内部采用单行注释 //
    • 文档开头应注释作者和具体日期
    • 类和方法必要时注释应该方法做什么事情,实现什么功能
    • 代码修改的同时,注释也要进行相应的修改
    • 常量注释

    变量命名

    1.代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
    2.代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

    3.成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。

    4.中括号是数组类型的一部分,数组定义如下:String[] args;

    5.枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。

    说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。

    每行最多字符数

    1.单行字符数限制不超过 120个,超出需要换行,换行时遵循如下原则:

    • 第二行相对第一行缩进 4个空格,从第三行开始,不再继续缩进,参考示例。
    • 运算符与下文一起换行。
    • 方法调用的点符号与下文一起换行。
    • 在多个参数超长,逗号后进行换行。
    • 在括号前不要换行,见反例。

    函数最大行数

    1.单个方法的总行数不超过80行。

    函数、类命名

    1.类名使用UpperCamelCase风格,必须遵从驼峰形式
    2.方法名、参数名都统一使用lowerCamelCase风格,必须遵从驼峰形式。

    3.抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。

    4.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。

    空行规则

    1.大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果是非空代码块则:

    • 左大括号前不换行。
    • 左大括号后换行。
    • 右大括号前换行。
    • 右大括号后还有else等代码则不换行;表示终止右大括号后必须换行。

    2.没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。

    注释规则

    1.类、类属性、类方法的注释必须使用Javadoc规范,使用/**内容*/格式,不得使用//xxx方式。

    说明:在IDE编辑窗口中,Javadoc方式会提示相关注释,生成Javadoc可以正确输出相应注释;在IDE中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。

    2.所有的类都必须添加创建者信息。

    3.方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐。

    4.与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。

    操作符前后空格

    1.左括号和后一个字符之间不出现空格;同样,右括号和前一个字符之间也不出现空格。

    2.if/for/while/switch/do等保留字与左右括号之间都必须加空格。

    3.任何运算符左右必须加一个空格。

    说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

    4.方法参数在定义和传入时,多个参数逗号后边必须加空格。

    常量

    1.常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

    2.不允许出现任何魔法值(即未经定义的常量)直接出现在代码中。

    冲刺任务与计划

    冲刺的时间计划安排

    前2天 开发工作:美化前端界面、未实现的接口拓展实现
    测试工作:alpha阶段的前期工作再测试整合。
    第3-5天:前端:漂流瓶界面、深夜食堂界面
    后端:漂流瓶部分的(捞、写(抛)、删除、查看、回复)等接口
    深夜食堂部分(获取、推荐、搜索、创建、删除、设置时间)等接口
    第6-7天:整合测试、修改bug

  • 相关阅读:
    day10作业
    day9 函数作业
    Python编码及文件练习题
    day10函数命名空间,嵌套,闭包
    Python基础数据类型考试题
    day9 函数
    day8 文件操作
    day7 集合
    day6 编码
    day5 作业自我完成版
  • 原文地址:https://www.cnblogs.com/RATE-MAX/p/12937526.html
Copyright © 2020-2023  润新知