在使用第三方库的类之前编写javadoc注释时,用于记录可以下载的第三方库名称,版本和Web地址的标准/官方方式是什么？是应该在说明中提到还是在块标签中使用(使用@see或自定义标签)？
取决于你想要完成的事情.
版本和下载链接应位于依赖关系管理工具的配置文件中(例如maven).这样,文档永远不会过时,并且在每个碰巧使用该特定API的类中都不会重复.
要发现哪些类使用哪个API,导入语句可以很好地工作(是的,可以通过使用限定的类名绕过import语句,但很少有人这样做,因为这使得源代码很难阅读).或者,只需从类路径中删除库,并查看编译错误发生的位置.
我建议不要在javadoc中记录这个,因为你的类的调用者应该不知道它的实现.也就是说,我认为API曾经是调用者不应该知道的实现细节 - 调用者不应该知道的不应该与他必须知道的东西混在一起.
| 归档时间： |
|
| 查看次数： |
66 次 |
| 最近记录： |