何时在方法开头使用块注释,何时使用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()
*/
我认为这里有某种样式,我没有在上面链接的评论规范中明确声明.