开发者社区 问答 正文

Java的注释是不是越多越好?

Java的注释是不是越多越好?

展开
收起
大葱蘸大酱2 2021-10-13 14:14:49 1175 分享 版权
1 条回答
写回答
取消 提交回答
  • 好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。

    反例:

    // put elephant into fridge

    put(elephant, fridge);

    方法名 put,加上两个有意义的变量名 elephant 和 fridge,已经说明了这是在干什么,语义清晰的代码不需要额外的注释。

    资料来源:电子书《阿里巴巴Java开发手册》,下载链接:https://developer.aliyun.com/topic/download?id=1092

    2021-10-13 14:16:41
    赞同 展开评论
问答标签: