Tag: javadoc

如何在运行时获取方法的JavaDoc？

在运行时很容易获得一个Class a method Name 但 我如何在运行时获取方法的JavaDoc ？ 如下例所示 我们的类包含我们的目标方法的JavaDoc public class MyClass { /** * * @param x value of …. * @return result of …. */ public String myMethod(int x) { return “any value”; } } 我们的类有一个主要方法 public class TestJava { public static void main(String[] args) { // get Class method Name at run […]

“/ *（非javadoc）”是否有一个易于理解的含义？

/* (non-javadoc)是否有意义，除了向源代码的读者指出注释块有意不是Javadoc注释？ 最近我看到很多代码看起来像这样： /* * (non-javadoc) * * This method converts widgets to gizmos */ public Foo bar() { … 这是某种既定的惯例吗？ 如果是这样，它是什么意思（超出明显的字面含义）以及何时使用？

Java Javadoc包括Private

我想为我的应用程序生成javadocs，我还想包括私有成员。 我在Javadoc文档中找到了以下内容 -私人的 显示所有类和成员。 你能举一个例子来帮助我吗？ 它应该是这样的： javadoc -private … 我需要知道如何为生成的html doc文件提供根目录和目标目录。 谢谢。 编辑：我找到了一种从NetBeans 6.8生成javadoc的方法。 这如下： NetBeans Java项目通常在项目的属性部分中具有此参数。 您可以在“项目”窗口中右键单击项目名称，然后选择“属性”。 在出现的“项目属性”窗口中，“文档”节点包含一个标记为“包括私有和包私有成员”的复选框字段。 我在这里找到了这个 似乎按需要生成文档。 谢谢大家。

如何通过reflection阅读Javadoc注释？

我需要知道如何在运行时读取Javadoc注释（可能是通过reflection？） 说我有以下function： /** * function that do some thing */ public void myFunc() { //… } 在运行时，我可以通过reflection获得有关此函数的大量信息。但是无法读取注释。 所以问题是，如何在运行时阅读这个javadoc注释。

用于匹配javadoc片段的正则表达式

这个问题让我在正则表达式中思考匹配包含一些指定文本的javadoc注释。 例如，查找包含@deprecated的所有javadoc片段： /** * Method1 * ….. * @deprecated * @return */ 我设法得到表达式/\*\*.*?@deprecated.*?\*/但在某些情况下失败，例如： /** * Method1 * ….. * @return */ public int Method1() { } // this method should be @deprecated public void Method2() { } /** * Method3 * ….. * @return */ public int Method3() { } 它匹配第一个javadoc片段中的所有代码，直到第三个javadoc片段。 有人能给这个正则表达式吗？

如何创建多语言JavaDocs？

JavaDoc是普通Java API的英文版和中文版，但似乎需要为每个版本分别提供源代码。 有没有更方便的方法来做到这一点？

如何从javadoc Ant任务的结果中排除特定的方法/构造函数？

我正在使用javadoc Ant任务生成的javadoc来记录Web服务，我想从输出中排除一些构造函数。 我怎么做？

如何创建自定义javadoc标签？

如何创建自定义的javadoc标签，例如@pre / @post？ 我发现了一些解释它的链接，但我没有运气。 这些是一些链接： http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

如何配置Intellij Idea javadoc模板？

我有一些方法： public int getSomeField() 我想像这样生成javadoc： /** * Gets {someField} * * @return value of {someField} */ 其中{someField}是字段名称的占位符。 可以为Intellij Idea创建此模板（可以作为实时模板）吗？

一个添加和完成PHP源代码文档的工具

我有几个完成的，较旧的PHP项目，包含很多我想用javadoc / phpDocumentor样式记录的包含。 虽然手动处理每个文件并被迫与文档一起进行代码审查将是最好的事情，但我只是出于时间限制，对工具感兴趣，以帮助我尽可能地自动完成任务。 我正在考虑的工具理想情况下具有以下function： 解析PHP项目树并告诉我哪里有未记录的文件，类和函数/方法（即元素缺少相应的docblock注释） 提供一种方法，通过创建空结构轻松添加缺少的docblocks，理想情况下，在编辑器中打开文件（内部或外部我不在乎），这样我就可以放入描述中。 可选的： 自动识别参数类型，返回值等。 但这并不是真的需要。 有问题的语言是PHP，虽然我可以想象一个C / Java工具可能能够在经过一些调整后处理PHP文件。 感谢您的宝贵意见！