在使用第三方库的类之前编写 javadoc 注释时,记录第三方库名称、版本和下载网址的标准/官方方法是什么?是否应该在描述中或 block 标记中提及(使用 @see
或自定义标记)?
最佳答案
取决于您想要完成什么。
版本和下载链接应该位于您的依赖管理工具(例如maven)的配置文件中。这样,文档就永远不会过时,并且不会在每个碰巧使用该特定 API 的类中重复。
要发现哪些类使用哪个 API,导入语句的效果非常好(是的,可以通过使用限定的类名来绕过导入语句,但很少有人这样做,因为这使得源代码很难阅读)。或者,只需从类路径中删除该库,然后查看哪里发生编译错误。
我建议不要在 javadoc 中记录这一点,因为类的调用者应该不知道其实现。也就是说,我认为 API 曾经是调用者不应该知道的实现细节 - 并且调用者不应该知道的东西不应该与他必须知道的东西混合在一起。
关于java - 记录 Java 中第三方库的使用的标准/官方方法是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22487182/