编码规范

1. 代码格式

  • java、js:采用Eclipse默认的格式化规则,自动格式化。
  • html、ftl:全手工调整,严格按照标签层级使用Tab缩进,不使用自动格式化。
  • xml:采用Eclipse默认的格式化规则,自动格式化,对个别格式化不美观的代码手工调整。

2. 代码检查

  • 要求src目录下的代码全部通过Sonar编码规则检查。
  • 设置Eclipse在保存Java代码时执行自动引用和自动格式化动作。
  • 关闭Eclipse的所有Validation规则。
  • 代码在Eclipse中不允许出现红色错误信息及黄色警告信息。
  • 保持代码清洁,对于注释不要的代码在提交前应确认移除。
  • 充分利用版本管理来管理代码,而不是留存注释掉的废代码。

3. 代码管理

  • 正确的代码更新步骤:同步 -> 解决冲突 -> 更新 -> 提交。
  • 提交的代码不允许出现编译错误。
  • 保持提交的代码随时可运行。
  • 经常同步代码和更新代码,避免出现大面积代码冲突。
  • 较大的代码改动,主动通知其他成员及时更新代码,避免出现大面积代码冲突。
  • 不要直接更新或提交代码,所有的操作之前先进行同步操作,查看服务器代码的变化,随时了解其它成员的操作,同时避免遗漏需提交的代码。

你可能感兴趣的:(编码规范)