程序设计技术标准(第一版)

2021年8月3日00:03:00 发表评论 100 views

注释规范

  1. 必须写函数注释,包括输入,输出参数类型和样例(可能的内容)

  2. 作用域超过20行的变量注释(必要时附带内容)

  3. 偶尔用感想做注释效果更好,例:这段代码有优化空间...

  4. 参数过多垂直编写时尽量每个参数参考第一条注释(见名知义除外)

  5. 简单介绍程序功能

  6. print前面必须加上字符串注释(后期可不必删除)

  7. 第一条中提交前需加入TODO以及反思改进空间(实现功能为主)

代码规范

  • 变量命名做到见名知义(长度不超过12个字符)

  • 善用换行,参数较多使用换行调整

  • 一行代码尽量不超过79个字符(按标准)

  • 临时参数(作用域不超过5行的)一律用tem开头

  • 作用域超过20行的参数写注释(非常清晰的例外)

  • 部分变量(重要或者常用)的标注变量内容(包括kv内容)

  • 函数参数一律设置(可能的)默认值

  • 未经允许不得在util库私自添加工具

  • 尽量不使用全局变量

  • 合作git注意操作顺序防止代码覆盖

  • 函数尽量不超过50、80行,多出需优化或拆分

  • 代码提交后需同事评审(可选)

  • 时常做好文件和数据库备份(干部负责)

  • A+
所属分类:java

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: