当前位置: 首页 > 面试题库 >

禁用JavaDocs的注释

壤驷泓
2023-03-14
问题内容

是否有注释声明某个方法即使是公共的也不会包含在JavaDocs中?

就像是:

@nojavadocs
public void foo(){
//...
}

附言:我了解这里有关API的要点,但是这些方法只是“不受支持”。它们可以工作(并且必须是公共的,以便从其他软件包访问),但是我们不希望在它们的功能与受支持的使用场景无关时,对其进行记录并回答有关如何使用它们的问题。好的设计可能意味着将它们移到另一个类,但是它们在逻辑上引用了该类中的数据。


问题答案:

如果您使用的是Sun的JavaDocs工具,则不会。

他们对此有功能要求,但是自1997年以来,它就一直处于低优先级。

您可以编写自定义doclet来克服此问题,或使用第三方工具(DocFlex等)。



 类似资料:
  • 可以使用javadoc工具生成Java文档。 它目前以html 4.0格式生成文档。 在java 9中,我们可以在命令行参数中使用-html5选项生成html 5格式的文档。 旧样式java文档 请考虑C:/ JAVA文件夹中的以下代码。 Tester.java /** * @author MahKumar * @version 0.1 */ public class Tester {

  • 我正在使用jackson库,我遇到了一种情况,我想在序列化/反序列化时使用对象映射器禁用@JsonFormat注释。 我的Api代码在第三方库中,所以我不能删除/添加任何注释,所以objectMapper是唯一的选择。 Api类别: 我的代码: 我希望这种转换成功发生。 目前我得到了:com.fasterxml.jackson.databind。JsonMappingException:格式无效:

  • 问题内容: 我正在研究javax.smartcardio类。我正在使用eclipse 3.6,并且拥有JDK 6 SE。我可以使用语句import javax.smartcardio。*或其任何单个类,只要我更改首选项以警告或忽略禁止的引用即可。 我在Java SE 6 的标准文档中没有提到javax.smartcardio, 也没有在eclipse中弹出javadoc帮助。我在这里找到了文档。

  • Java文档可以使用工具生成。 它目前以格式生成文档。 在java 9中,可以通过在命令行参数中使用选项生成格式的文档。 旧式的java文档 考虑F:\worksp\java9文件夹中有一个Java文件:Tester.java,其代码如下 - 可以运行jdk 7 的javadoc工具来生成文档。 使用标志运行jdk 9的javadoc工具以生成新类型的文档。 打开生成的文件,如下所示 -

  • 我使用Intellij思想,当我去生成JavaDocs(通过Tools->generate JavaDoc)时,我会被抛出一个IllegealArgumentException,其中没有关于哪里出错的信息。 当使用模块中的每个单独文件进行测试时,即使没有JavaDoc注释,也会发生这种情况。 使用Java8和IntelliJ IDEA 2016.1.1

  • 问题内容: 我需要在我的JavaDoc评论中添加。问题在于,这也是关闭评论的相同顺序。引用/转义的正确方法是什么? 例: 跟进 :看来我可以使用斜线。唯一的缺点是,当直接在文本编辑器中查看代码时,这并不是所有可读性。 问题答案: 使用HTML转义。 因此,在您的示例中: 转义为“ /”字符。 Javadoc应该在其生成的HTML中插入完整的转义序列,并在浏览器中将其呈现为“ * /”。 如果你要非