Tag: javadoc

如何在Android Studio中生成javadoc注释: 我可以在Android Studio中使用快捷键来生成javadoc注释吗？如果不是，那么生成javadoc评论的最简单方法是什么？

Javadoc链接到其他类中的方法: 目前我正在用这个Javadoc语法引用其他类中的方法： @see {@link com.my.package.Class#method()} 而在我从文档中明白这是做到这一点的正确方法。但现在到了有趣的部分，还是令人沮丧的。当我生成这个javadoc我首先得到以下错误： warning – Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}" warning – Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}" warning – Tag @see: reference not found: {@link com.my.package.Class#method()} 这个生成的HTML代码是： "," <code>com.my.package.Class#method()}</code> "," 当然，我没有联系。谁能告诉我发生了什么，以及有关如何解决这个问题的任何提示？根据ASCII表字符123和64代表{和@，为什么这些字符在这个语法正确时根据文档是否有效？

撰写伟大的Javadoc的技术提示: 你有什么技巧来写伟大的Javadoc？我正在寻找超越标准的“解释function”的内容提示。我们都知道！（对？）我对这样的事情感兴趣：什么标签应该是Javadoc的一部分，哪些不值得记住？你什么时候使用@see和{@link} ？总是有必要使用@ @param显而易见的参数？你如何防止重写@param和@return文本的方法的描述？在Javadoc中包含HTML是否合适？最后，任何人都可以指出一个好的，简洁的Javadoc标签列表？

你怎么能逃避javadoc中的@字符？: 我如何逃避javadoc中的@符号？我正在尝试在<pre>标签内使用一个{@code}标签。我已经试过了html转义@ 序列，但没有工作。

codestyle; 在注释之前或之后放置javadoc？: 我知道这不是最重要的问题，但我只是意识到，我可以在注释之前或之后放置javadoc注释块。我们希望采用什么作为编码标准？ /** * This is a javadoc comment before the annotation */ @Component public class MyClass { @Autowired /** * This is a javadoc comment after the annotation */ private MyOtherClass other; }

如何在Java中logging包？: 在Java API中，我可以看到Javadoc对包的评论。我如何/在哪里放置Javadoc评论来logging一个包？

获取附加到Eclipse以获得Mavenpipe理的依赖关系的源jar文件: 我正在使用Maven（和Maven Eclipse Integration）来pipe理Eclipse中Java项目的依赖关系。来自Maven仓库的JAR文件的自动下载function是一个实时的节省。不幸的是，它不包含API文档和源代码。我如何设置Maven自动获取源代码和javadoc附件，并在Eclipse中正确注册它们？

使用javadoc的Python文档: 我现在开始使用Python，我有一个强大的PHP背景，在PHP中，我习惯于使用javadoc作为文档模板。我想知道如果javadoc在Python中作为docstring文档的地方。像这样的东西太复杂了，以适应Python的思维方式，还是应该尽可能简洁？ """ replaces template place holder with values @param string timestamp formatted date to display @param string priority priority number @param string priority_name priority name @param string message message to display @return string formatted string """ 如果我有点太详尽，我应该去这样的事情（而大多数的文档不通过__doc__方法打印）？ # replaces template place holder with values # # @param string timestamp formatted date to display […]