代码规范+任务规划

讨论图片

编码规约

缩进与空格

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

各类命名

类命名

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

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

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

函数最大行数

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

常量问题

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

空行规则

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

注释规则

  • 类和方法采用/* 内容*/格式进行注释
  • 方法内部采用单行注释 //
  • 文档开头应注释作者和具体日期
  • 类和方法必要时注释应该方法做什么事情,实现什么功能
  • 代码修改的同时,注释也要进行相应的修改
  • 常量注释
posted @ 2020-04-26 23:55  RATE-MAX  阅读(214)  评论(2编辑  收藏  举报