Questions tagged «javadoc»

Javadoc是一个可扩展的文档生成系统，该系统以Java源代码的形式读取特殊格式的注释并生成已编译的文档。它通常用于以HTML网页的形式生成API文档。

2
是否有一个Javadoc标记用于记录通用类型参数？
我一直在浏览Sun网站上的javadoc文档，试图找到是否有一个javadoc标记可用于记录类或方法的通用类型签名。 类似于@typeparam，类似于通常@param，但适用于类型和方法，例如 /** * @typeparam T This describes my type parameter */ class MyClass<T> { } 我怀疑没有这样的标记-我在任何地方都找不到它的标记，并且JavaSE API文档没有显示任何标记，但这似乎是一个奇怪的遗漏。有人可以说对吗？
165 java  javadoc 
4
将javadoc用于Python文档[关闭]
已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我目前从Python开始，我有很强的PHP背景，在PHP中，我习惯于javadoc用作文档模板。 我想知道它是否在Python文档中javadoc占有一席之地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 …
4
Android Studio：悬停时Javadoc为空
我最近从Eclipse迁移到Android Studio，并且很喜欢它。但是，我想念Eclipse的Javadoc on hover功能。 我按照此处的说明添加了功能，但是，我的徘徊者不包含Javadoc。如果我使用文档快捷方式Ctrl+ Shift+ Space，它将正确显示文档，但是，我真的希望它出现在工具提示中。 下面是我所看到的屏幕截图。显然，此方法上应该有一个Javadoc。 我在所有方法/变量上都看到了这一点。任何帮助表示赞赏。
7
在Android Studio中更改作者模板
我想更改在AndroidStudio中创建文件时出现的自动作者。 /** * Created by a556520 on 16/01/14. */ public class POI { 作者的名字是“ a556520”，但我希望显示我的名字，而不是雇员人数。那可能吗？我在设置中找不到。
11
Javadoc的好例子
关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow 的主题。 3年前关闭。 改善这个问题 有一个包含Javadoc的源文件的好例子吗？ 我可以在Internet上找到很多很好的Javadoc示例，我只是想找出创建它们的特定语法，并假设我可以在某个地方浏览某些库的源代码，但这似乎需要很多工作。
140 java  javadoc 
14
简单的Getter / Setter注释
您使用什么约定来评论获取方法和设置方法？这是我很长时间以来一直想知道的事情： /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); 我总是发现我几乎为1a / b和2a / b写了完全相同的东西，例如1a）设置员工的薪水，1b）员工的薪水。似乎太多余了。现在我可以看到对于更复杂的内容，您可以在（a）部分中编写更多内容，以提供具体背景信息，但是对于大多数使用方法的人来说，措辞几乎完全相同。 我只是好奇，对于简单的获取者/设置者而言，仅填写（a）部分还是（b）部分是否可以。 你怎么看？
3
如何使用Javadoc @link到枚举值
使用Javadoc 1.5，我无法创建指向Enumeration值的@link。 我想做的是创建一个像这样的枚举： public enum Planet { /** * MERCURY is a fun place. */ MERCURY, /** * VENUS is more fun. */ VENUS, /** * But nothing beats the Earth. */ EARTH, /** * Others we know nothing about. */ OTHERS } 然后使用类似这样的链接引用Earth的Javadoc： {@link Planet.EARTH} 我也尝试过这种{@link Planet#EARTH}风格，但无济于事。 有人知道这是否可行吗？
120 java  javadoc 
3
Intellij IDEA自动显示javadoc
当我在Netbeans编码时，它会自动完成代码并显示Javadocs。但是，当我使用Intellij IDEA时，如果单击Ctrl+Space，则可以看到自动完成功能；如果单击Ctrl+Q，则可以分别看到javadoc。 每当我看到像Netbeans这样的自动完成或在Intellij IDEA上单击Ctrl+Space时，都可以看到element的Javadoc 吗？
3
Netbeans：如何更改@author
在Netbeans IDE中创建新类或接口时，将显示“ @author ....”标记。如何改变它的价值？如果可能的话，我想使用Netbeans菜单而不是编辑一些配置文件来更改它：)我正在使用Netbeans 7.2
4
JavaDoc中@see的用法？
什么时候使用@see与JavaDoc中处理时？它的用途是什么？ 例如，如果MethodA呼叫MethodB然后做我必须把@see中MethodB的javadoc和引用MethodA，因为这就是所谓呢，还是我已经把一个引用MethodB从MethodA，因为它调用它。我已经阅读了@seeOracle网站上的内容，在我看来似乎非常模糊，它表示“请参见”，但实际上并不意味着！
110 java  methods  javadoc 
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.