论代码规范的重要性

2020-04-08 12:25:02    敏捷剧务    3427    转贴: 禅道1

关于代码规范:

一、代码规范主要包括命名、版式、注释等几个方面。

  • 命名包括变量、类、方法、文件名、数据库、表、字段、接口等方面。
  • 版式包括缩进、换行、对齐、大括号、循环体、逻辑判断等方面。
  • 注释包括包注释、文件注释、类注释、方法注释、参数注释、变量注释、代码片段注释等。

二、代码规范原则:

  • 是否是驼峰还是匈牙利方法不重要,重要的是执行。
  • 最重要的是命名,与其绞尽脑汁写注释,不如想想如何命名。
  • 好的版式易于阅读,学会用换行和注释做代码片段区隔。
  • 注释最重要是正确,一定要和代码保持同步。

三、代码规范的重要性:

  • 统一的代码规范是代码集体所有权的基础。
  • 统一的代码规范结对编程也会愉快很多。
  • 统一的代码规范可以让大家轮岗更容易。
  • 轮岗机制打通,可以让大家获得内部提升和晋升。


鲁ICP备18054969号-11
ZSITE8.6