编码规范
博客专区 > Jnoee 的博客 > 博客详情
编码规范
Jnoee 发表于3年前
编码规范
  • 发表于 3年前
  • 阅读 34
  • 收藏 0
  • 点赞 0
  • 评论 0

标题:腾讯云 新注册用户域名抢购1元起>>>   

摘要: 应避免采用长篇大段的文档描述编码规范,因为大部分开发人员都不会去看它,更几乎没有哪个开发人员会在编码时记得这些东西。应尽可能采用IDE以及代码检查工具来规范编码规则,让开发人员在编码的过程中熟悉和适应这些规则。

#1. 代码格式

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

#2. 代码检查

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

#3. 代码管理

  • 正确的代码更新步骤:同步 -> 解决冲突 -> 更新 -> 提交。
  • 提交的代码不允许出现编译错误。
  • 保持提交的代码随时可运行。
  • 经常同步代码和更新代码,避免出现大面积代码冲突。
  • 较大的代码改动,主动通知其他成员及时更新代码,避免出现大面积代码冲突。
  • 不要直接更新或提交代码,所有的操作之前先进行同步操作,查看服务器代码的变化,随时了解其它成员的操作,同时避免遗漏需提交的代码。
共有 人打赏支持
粉丝 4
博文 8
码字总数 5282
×
Jnoee
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: