【第28条】为所有导出的API元素编写文档注释

xiaoxiao2026-05-22  42

    Javadoc真是个好东西。它简直太奇妙了,简直就是“懒人乐”。

 

    其实,不仅仅是受“懒人”欢迎,它还有标准化、一元化等其他好处...

 

    那么,懒人们可听好了:为了正确地编写API文档,你必须在每一个被导出的类、接口、构造函数、方法和域声明之前加上文档注释。每一个方法的文档注释应该简洁地描述出它和使用者之间的约定。

 

    具体的@语法,这里就不介绍了。

 

 

 

【Effective Java 学习笔记】系列连载专题请见: http://tonylian.iteye.com/categories/64208

相关资源:JAVA上百实例源码以及开源项目
转载请注明原文地址: https://www.6miu.com/read-5049196.html

最新回复(0)