代码规范、注释

每家公司都强调代码规范性、注释的必要性。个人工作中的理解:

1,代码规范性,有必要。内部整理一套适合自己公司的代码规范,整个公司培训。具体定制规则可以参考阿里巴巴出品的【阿里巴巴Java开发手册】,裁剪出适合自己的规范。

2,注释。除非是公司文化比较浓厚,比如日企。代码注释写得比较全面,而且维护很好。其他公司基本是规划全面,无法落地。

推荐做法:

1,包名、类名、方法名做统一要求,见明之意。

2,好的代码本身就是注释,读一遍就能理解作者意图。

3,适量注释即可,成片的注释没人花时间去理解,文字理解偏差也很大,而且作者也不会实时维护注释,很大可能注释已经跟代码完全不匹配了。

4,如一定要写方法参数、方法返回值等javadoc型注释,最好用工具统一生成,避免不必要的人工成本。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值