撰写伟大的Javadoc的技术提示
您的 技术 提示是否写出了伟大的Javadoc？ 我在寻找东西>超越标准“解释功能”内容的提示。大家都知道！ （对吗？） 我对这些事情感兴趣： 什么标签应该是Javadoc的一部分，哪些不值得记住？ 你什么时候使用 @see vs {@ link} ？ 始终需要使用 @param 对于明显的参数？ 如何阻止对方法的描述重新迭代 @param 和 在Javadoc中包含HT
..
javadoc相关内容
Maven - Java EE 6 Web Profile Javadocs
通过声明以下依赖关系： javax javaee-web-api 6.0 已提供 我可以使用我所需要的一切Java EE 6项目（Se
..
CODE Delphi的文档创建工具
可能重复： 类似于javadoc或c＃xml doc的delphi的代码文档 我想开始记录一个非常大的Delphi应用程序，目前它没有任何文档。我的同事建议使用javadoc类型的文档样式，因为我们可以运行一个自动化程序来创建可搜索和漂亮的漂亮文档。 （*功能描述 @param S某些字符串 @param索引字符串索引s @retval TRUE条件是真的 @retva
..
delphi的代码文档类似于javadoc或c＃xml doc
我需要一个与javadoc或c＃xml doc相似的代码文档工具，用于delphi代码。什么是最好的工具？我更喜欢一种技术，这在未来与微软沙堡项目兼容。 解决方案 看看 SynProject ，一个用Delphi编写的开源工具。 它旨在处理完整的文档工作流程，从规范到发行说明，包括测试，架构和设计;当然，还有一个集成的Delphi解析器，可以从现有的Delphi源代码生成架构文档。
..
用于emacs的最佳java工具
我是一个长时间的emacs用户，现在我在Java中工作了大约一半的时间。 / p> 调试Java 代码完成/ Intellisense Javadoc浏览 ？ 解决方案我在几个项目中使用了 JDEE 。它处理代码完成。我从来没有使用它来调试或浏览文档，但它是从基本的文本编辑器中大步走。
..
如果weakCompareAndSet如果实现完全像compareAndSet，会如何失败？
（请注意，此问题不是关于CAS的，而是关于“可能会失败的错误” Javadoc）。 AtomicInteger 类中这两个方法之间的Javadoc是 weakCompareAndSet 包含注释：“May fail spuriously” 。 现在除非我的眼睛被某些法术所欺骗，否则这两种方法看起来都是完全一样的： public final boolean compareAndS
..
如何从Android Studio中删除特定文件中的所有评论？
我在我的项目中有一些大文件，有很多行注释过。 通常当我在代码中更改某些内容时，测试删除它们。 但是有时在一个大文件中有太多的注释，很难删除它们。 所以，可能有一些函数Android Studio从评论中“清理”文件（当然不包括javadoc注释），例如“整理导入”，用于删除文件中未使用的导入。 或者，也许，某种高亮注释的行，所以我 你能帮助我吗？ 任何想法都很赞
..
如何在Javadoc中添加包级别的注释？
我使用Check-Style，FindBugs和PMD来验证我的Java代码。我已经修复了这些工具捕获的几乎所有的错误。 我无法理解如何编写“包注释”，这是由checkstyle捕获的错误。我已经经历了Check-Style的文档，但是我不明白。 有人可以帮我在Java中写一个包级别的注释吗？ 解决方案 包级别的javadoc注释放在名为 package-info.java的文
..
Javadoc像C＃的XML注释的文档
我在找一些东西把我的C＃XML注释转换成文档。我不喜欢CHM的，也不喜欢MSDN的外观和感觉。我喜欢使用javadocs。他们很容易浏览，一切都可以访问。我正在寻找一个工具，我可以使用将我的代码中的意见转换为一个javadoc喜欢的外观和感觉。 有什么事情吗？我试过Sandcastle，它是各种GUI，但他们不做我想要的。 解决方案 Doxygen 可能？
..
javadoc中的Unicode和注释？
某些编译器在JavaDoc和源代码注释中对非ASCII字符失败。相对于Java源文件中的Unicode，当前（Java 7）和未来（Java 8和更高版本）的做法是什么？ IcedTea，OpenJDK和其他Java环境之间是否存在差异，什么是语言规范？是否所有非ASCII字符在JavaDoc中使用HTML &escape; 类似代码转义？ 更新：注释表示可以使用任何字符设置，并且在编译时，
..
如何在没有自动DocBlock格式的NetBeans中执行多行注释？
有时在我的代码中我喜欢注释一段代码临时使用/引用等，例如： / * blah * / 一个小麻烦，如果我然后想去插入一行内的块，当我单击enter，它会自动把一个*在下一行，就像我做一个DocBlock。这发生在每个输入键： / * blah * * / “自动格式
..
哪个标记应该在Javadoc中用作段分隔符？
哪个是更合适的HTML标签用于分解javadoc的段落/长段，以便根据最佳做法？ 是
或
？为什么？ 解决方案 欢迎来到HTML 3.2。 根据关于编写文档注释的官方指南，分隔段落的正确方法是使用段落标签：
。请查看文档备注格式部分中的第七个项目符号 a>。 通常，我强烈建议不要使用这些旧的，过时的标记做法。然而，在这种情况下
..
是“/ *（非javadoc）”有一个很好理解的意义？
/ *（non-javadoc）有一个意义，除了指出源代码的读者注释块是故意不是Javadoc注释？最近我看到很多代码看起来像这样： / * *（非javadoc） * *此方法将窗口小部件转换为gizmos * / public Foo bar（）{ ... 这是既定的惯例吗？ 解决方案 根据信息我可以找到，这是修复的旧版本的错误Java
..
如何报价“* /”在JavaDocs
我需要在我的JavaDoc注释中包含 * / 。问题是，这也是关闭注释的顺序。 例如： / ** *如果指定的字符串包含“* /”，则返回true。 * / public boolean containsSpecialSequence（String str） up ：看来我可以使用&＃47; 作为斜杠。唯一的缺点是，在文本编辑器中直接查看代码时，这不是
..
简单的Getter / Setter注释
您使用什么约定来评论getter和setter？这是我想知道的一段时间，例如： / ** *（1a）你在这里放什么？ * @param salary（1b）你把什么放在这里？ * / public void setSalary（float salary）; / * *（2a）你在这里放什么？ * @return（2b） * / public float
..
应该将JavaDoc注释添加到实现中
在Interface中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？ 当您自动生成注释时，大多数IDE会为实现生成非JavaDoc注释。不应该具体的方法有描述？ 解决方案 对于只实现（不覆盖）的方法， ，特别是如果他们是公开的。 如果你有一个凌驾的情况，你要复制任何文本，那么绝对不是。复制是造成差异的确定的方式。因此，用户将根据他们是否检查超类型或子类型中的
..
/ **和/ *在Java中的注释
之间有什么区别 / ** *评论 * * * / 和 / * * *评论 * * / 在Java？我应该何时使用它们？ 解决方案 第一种形式称为 Javadoc 。当你为你的代码编写正式的API时，你会使用它，这是由 javadoc 工具生成的。例如， Java 7 API页面使用Javadoc并由该工具生成
..
Java运行时exec（）行为
我试图通过 Runtime 的实例通过 exec（）方法以编程方式生成javadoc生成javadoc所需的命令。首先我不熟悉通过命令行创建javadocs，第二我不熟悉来自 Runtime 的exec（）方法。作为一个测试，我能够通过 exec（）命令执行从C＃类编译的可执行文件，但是不能用C ++类编译的可执行文件，行为？此外，在指向JDK bin目录时，我无法通过 exec（）命令执行jav
..
通用javadoc命令总是生成给定树中的所有javadoc？
当我为一个新的，不熟悉的项目生成javadoc时，我发现我花了很长时间试图简单地写正确的命令，指定所有的包，所有的源代码树等。这是耗时和错误-prone：我可能缺少一些来源。 所以让我们说我有一个目录myproj，下面有一些包（和各种其他资源和东西），在这些包目录下最终有一些src /目录，然后是很多的/ awesome / java / project / package类型的结构。
..
如何从命令行生成Javadoc
任何人都可以告诉我如何从命令行生成Javadoc？ 我的项目包含包 com.test 我想将生成的文档放在特定文件夹中的文件夹中，如下所示： C：/ javadoc / test 。 解决方案 您可以参考 java doc工具1.5页这里 我想你正在看的是像 javadoc -d C：/ javadoc / test com.mypackage
..