Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/windows/17.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
什么';在Java中记录第三方库的使用的标准/官方方式是什么?_Java_Javadoc - Fatal编程技术网

什么';在Java中记录第三方库的使用的标准/官方方式是什么?

什么';在Java中记录第三方库的使用的标准/官方方式是什么?,java,javadoc,Java,Javadoc,在使用第三方库的类之前编写javadoc注释时,记录第三方库名称、版本和网址的标准/官方方式是什么?应在说明中提及还是在块标记中提及(使用@参见或自定义标记) 是否应在说明中或在块标记中提及(使用@see或自定义标记) 只需在描述中的某个地方提及它,(个人)最好在结尾处提及。不要为这样的东西定义自定义标记,这不值得这么麻烦。重要的是(如果必要的话)信息就在那里。做这件事没有固定的惯例 我故意说“如果必要的话”——大多数时候我会说这根本不需要。然而,如果处理一个不广为人知的库,而不是Maven中的

在使用第三方库的类之前编写javadoc注释时,记录第三方库名称、版本和网址的标准/官方方式是什么?应在说明中提及还是在块标记中提及(使用
@参见
或自定义标记)

是否应在说明中或在块标记中提及(使用@see或自定义标记)

只需在描述中的某个地方提及它,(个人)最好在结尾处提及。不要为这样的东西定义自定义标记,这不值得这么麻烦。重要的是(如果必要的话)信息就在那里。做这件事没有固定的惯例


我故意说“如果必要的话”——大多数时候我会说这根本不需要。然而,如果处理一个不广为人知的库,而不是Maven中的库和/或有在不同版本之间进行突破性更改的倾向,那么至少在某个地方记录这一点是值得的。

取决于您想要完成什么

版本和下载链接应该在依赖项管理工具(如maven)的配置文件中。这样,文档就不会过时,也不会在每个使用特定API的类中重复

为了发现哪些类使用哪种API,import语句工作得非常好(是的,可以通过使用限定的类名绕过import语句,但很少有人这样做,因为这使得源代码很难阅读)。或者,只需从类路径中删除库,然后查看编译错误发生的位置


我建议不要在javadoc中记录这一点,因为类的调用方应该不知道它的实现。也就是说,我认为API是一个调用者不应该知道的实现细节,而调用方不应该知道的东西不应该与他必须知道的事物混合。做你公司或组织规定的事,或者你认为最好的事。我只想说一个好问题。我希望有更多的人考虑这个问题。然而,我认为大多数开发人员只会说它是由import语句记录的,那么为什么要在Javadoc中提到它呢?由于这可能是大多数人的意见,我怀疑是否有一个最佳实践。也许最好只是创建自己的标准,并在这个特定的库中始终如一地遵循它。我同意Scott的观点,也不同意接近票数的人的观点——这方面没有固定的惯例,但这是一个好问题,即使答案只是“没有”这个问题在StackExchange站点上可能更合适。