开发者社区 问答 正文

阿里巴巴中的Javadoc注释规范是什么呢?

已解决

阿里巴巴中的Javadoc注释规范是什么呢?

展开
收起
游客3gzok77e677xw 2022-04-03 10:32:23 747 分享 版权
1 条回答
写回答
取消 提交回答
  • 推荐回答

    对于注释的要求:

    能够准确反映设计思想和代码逻辑,能够描述业务含义,使其他程序员能够迅速了解代码背后的信息。完全没有注释的大段代码对于阅读者形同天书;注释是给自己看的,应做到即使间隔很长时间,也能清晰理解当时的思路,注释也是给继任者看的,使其能够快速接替自己的工作。

    特殊注释标记,请标明标记人与标记时间。注意及时处理这些标记,通过标记扫描经常处理此类标记。有时候线上故障就来源于这些标记处的代码。

    2022-04-03 13:57:14
    赞同 展开评论
问答地址: