Files
Hui-s-notebook/注释规范.md
2024-05-09 22:58:28 +08:00

422 B

Javadoc 用于每一个 public 或 protected 对于方法有参数,返回值,异常,需要在 javadoc 块中描述 注释的要求 准确反映设计思想和代码逻辑 能够描述业务含义,迅速了解代码背后的信息 所有类必须添加创建者和日期 所有枚举字段必须要有注释,说明每个数据项用途 好的命名,结构是自解释的,注释要精简准确、表达到位