Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/java/345.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
从命令行生成javadoc注释_Java_Javadoc_Generate - Fatal编程技术网

从命令行生成javadoc注释

从命令行生成javadoc注释,java,javadoc,generate,Java,Javadoc,Generate,编辑 (再次强调,这是计划用于getter和setter模型类,这些类完全可以自动生成注释,不会带来任何价值。因此,请提供信息,如果您知道工具或方法,请不要进入讨论“如果应该做”。我已经知道它不应该!) 有许多解决方案可以自动生成java文档注释,特别是eclipse或intellyJ插件。注释应该简单为getter/setter上的注释。 比如说 /** * Gets name. * * @return the name. */ public String ge

编辑 (再次强调,这是计划用于getter和setter模型类,这些类完全可以自动生成注释,不会带来任何价值。因此,请提供信息,如果您知道工具或方法,请不要进入讨论“如果应该做”。我已经知道它不应该!)

有许多解决方案可以自动生成java文档注释,特别是eclipse或intellyJ插件。注释应该简单为getter/setter上的注释。 比如说

  /**
   * Gets name.
   *
   * @return the name.
   */
  public String getName() {
    return name;
  }
但我要做的是找到一个可以从命令行作为脚本运行的解决方案

我想要实现的是能够在类似classname.java的东西上运行脚本

$ ./addAutoGeneratedComments -i SomeClassName.Java -o SomeClassName2.java 
我花了无数个小时来寻找这样一个解决方案或一个很好的指南,但我没能找到。我发现的最接近的事情是我无法编译它


我非常感谢您的帮助,与此类主题相关的链接足以让我从某个地方开始。

您想这样做有什么特别的原因吗?自动生成的注释很少对其他人有用(您提供的示例就是一个很好的例子-注释中没有任何您从方法名称中不知道的内容)。添加这些自动生成的注释没有任何价值。你为什么要那样做?与没有javadoc注释相比,它没有任何信息价值,因为所有信息都是直接从签名中推断出来的。在我看来,这样的javadoc不仅毫无用处,而且会把代码弄得乱七八糟。看在上帝的份上,请停止写这样的注释。他们什么也没告诉读者。它们比什么都不说更糟糕,因为这意味着有人知道需要发表评论,并明确选择不告诉读者来侮辱读者。该注释应该解释名称是否可以为null、是否有长度限制、是否有字符限制、是否应该是人类可读的、是否来自用户输入以及是否是对象的唯一标识符。遗留代码、大量getter和setter需要注释。让老板高兴是有用的。对我来说,零价值+大量无用的努力。你想这样做有什么特别的原因吗?自动生成的注释很少对其他人有用(您提供的示例就是一个很好的例子-注释中没有任何您从方法名称中不知道的内容)。添加这些自动生成的注释没有任何价值。你为什么要那样做?与没有javadoc注释相比,它没有任何信息价值,因为所有信息都是直接从签名中推断出来的。在我看来,这样的javadoc不仅毫无用处,而且会把代码弄得乱七八糟。看在上帝的份上,请停止写这样的注释。他们什么也没告诉读者。它们比什么都不说更糟糕,因为这意味着有人知道需要发表评论,并明确选择不告诉读者来侮辱读者。该注释应该解释名称是否可以为null、是否有长度限制、是否有字符限制、是否应该是人类可读的、是否来自用户输入以及是否是对象的唯一标识符。遗留代码、大量getter和setter需要注释。让老板高兴是有用的。对我来说,零价值+大量无用的努力。