输出注释比例java_好的 Java 程序,注释的比例一般到多少?

写了个模块,边写代码边写注释,完了之后发现注释比例接近50%了……

关键是,这50%大多是文件、类、属性、方法前面的 JavaDoc,代码流程里面的注释其实不多。

我删掉了很多废话,但实在是删不动了。

求问,注释比例这么大,是不是程序设计上出现了一些问题?比如模块划分得过细?

好代码本身就是注释,至于作者版本信息之类的内容,根本就不应该放在源代码里,话说版本控制系统不就是干这个的么?

能一行注释不要又能让别人看懂的代码才是好代码。

PS. API的注释相当于接口文档,这对于公共库来说当然是必需的,要不然没人知道你的库怎么用。

PPS. 注释的目的在于解释代码中无法明示的问题,比如旧版本的兼容性、采用特殊做法/算法原因等,没有目的的注释除了降低代码质量,唯一的用处就是满足领导制定的KPI了。

昨天刚看了华为的java编程规范里面面有说到这个问题:30%

不觉得注释要有一定比例,当你看不懂时,文档就是救命稻草,显然是越多越好!

JavaDoc本身就非常有用的。

我听过一句话,好的代码它本身就是注释。

代码如果写得可读性好,其实注释并不那么重要。

注释比例大不大和你的模块设计的合不合理没有直接关系。

举个例子来说你看看android Activity的注释和你的比较一下

https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/Activity.java

能让人比较

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值