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

Javadoc注释与块注释?

公冶子安
2023-03-14
问题内容

什么时候在方法开始时使用块注释,什么时候使用Javadoc风格的注释?

在Java样式指南的“注释”部分中,我发现了这一点:

Java程序可以有两种注释:实现注释和文档注释。实现注释是在C ++中发现的,由/*...*/,和//
分隔。文档注释(称为“文档注释”)仅适用于Java,并以分隔/**...*/。可以使用javadoc工具将Doc注释提取到HTML文件中。

实现注释用于注释掉代码或有关特定实现的注释。Doc注释旨在从无实现的角度描述代码规范。供可能不一定拥有源代码的开发人员阅读。

因此,用另一种方式表达我的问题的方式是:从无实现的角度(Javadoc)而不是对特定实现的评论,方法何时应指定代码规范?反之亦然?接口将获取javadoc注释,而实现方式将获取块注释吗?

编辑: 根据目前的答案,我认为我的问题没有正确传达。

这是我想知道的一个例子。

/**
 * Javadoc comment here about general implementation?
 */
/*
 * Should I now have a separate block comment for my specific implementation?
 */
public void foo()
{
...
}

两种不同的注释样式传达两种不同类型的信息。在某些情况下,方法应该同时具有一个领先的javadoc注释和一个领先的块注释吗?

甚至询问的灵感是Eclipse刚刚为我自动生成了这个:

/*
 * (non-Javadoc)
 * @see my.package#process()
 */

我发现这里有些样式在我上面链接的注释规范中没有明确声明。


问题答案:

信息的 一类用户 需要知道应该进入Javadoc注释。

修改类开发人员 需要知道的信息放入常规注释(块或行)。

并且,当需要公开可见的内部代码以及内部文档时,任何代码块(类,接口,字段,方法,构造函数等)都可能 同时 具有Javadoc注释和普通注释块。

就我个人而言,我倾向于编写很少的非Javadoc注释,因为我更喜欢以自我记录的方式来构造代码。



 类似资料:
  • 主要内容:Javadoc标签,Javadoc命令,DOS命令生成API帮助文档 ,MyEclipse生成API帮助文档,文档注释的格式Java 支持 3 种注释,分别是单行注释、多行注释和文档注释。文档注释以 开头,并以 结束,可以通过 Javadoc 生成 API 帮助文档,Java 帮助文档主要用来说明类、成员变量和方法的功能。 文档注释只放在类、接口、成员变量、方法之前,因为 Javadoc 只处理这些地方的文档注释,而忽略其它地方的文档注释。 Javadoc 是 Sun 公司提供的一种工

  • 问题内容: 一些编译器对JavaDoc和源代码注释中的非ASCII字符失败。关于Java源文件中的Unicode,当前(Java 7)和将来(Java 8及更高版本)的做法是什么?IcedTea,OpenJDK和其他Java环境之间是否有区别,语言规范规定了什么?是否应使用HTML &escape; 在JavaDoc中对所有​​非A​​SCII字符进行转义 。 类似的代码?但是,Java //注释

  • 本文向大家介绍racket 块注释,包括了racket 块注释的使用技巧和注意事项,需要的朋友参考一下 示例            

  • 问题内容: 是否有任何工具/ Eclipse插件可以删除文件中的所有JavaDoc注释? 运行该工具后, 普通 (非JavaDoc)注释 应完整无缺 。 问题答案: 尝试使用此正则表达式在eclipse / sed /您最喜欢的具有正则表达式支持的编辑器中搜索替换。 将输入视为单行 起始字符串 零或更多 负面的展望 空格或非空格字符 尾随字符串 编辑 要解决字符串包含javadoc的情况,请使用此

  • 我正在尝试构建一个aar,以便在jcenter上发布。 assembleRelease任务工作正常,javadoc任务也工作正常,但javadocJar任务输出以下错误: /Users/martinmoreno/Projects/android-dev-utils/dev-utils/src/main/java/com/tinchoapps/devutils/BitmapUtils.java:11

  • 关于java.lang.enum.values()方法,我有一个非常具体的问题。 我也很好奇为什么不能重写。我在其他问题上读到“它是由编译器生成的”。但有人能更精确一点吗?它似乎是从枚举的名称生成的,但它没有解释原因。