我目前从Python开始,我有一个强大的PHP背景,在PHP中我习惯使用javadoc作为文档模板.
我想知道它是否javadoc有它作为docstringPython文档的位置.这里有既定的惯例和/或官方的guildelines？
例如,这样的东西太精巧,不适合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
# @param string priority priority number
# @param string priority_name priority name
# @param string message …我想更改在AndroidStudio中创建文件时出现的自动作者.
/**
* Created by a556520 on 16/01/14.
*/
public class POI {
作者采用'a556520',但我希望这看起来是我的名字,而不是员工的数量.那可能吗？我没有在设置中找到.
有一个包含Javadoc的源文件的好例子吗？
我可以在互联网上找到很多很好的Javadoc示例,我只想找出用于创建它们的特定语法,并假设我可以在某处找到某些库的源代码,但这似乎很多工作.
在Eclipse中,我可以按Alt+ Shift+ J并获得一个javadoc注释,该注释自动生成字段,返回或适用于该特定javadoc注释的任何内容.我假设IntelliJ IDEA具有此功能.谁能告诉我是否有键盘快捷键？
我不喜欢在创建一个或多个类时为我生成的默认Javadoc,尤其是@author变量,它是我的Windows框中的当前系统用户名.
我想改变它.这可能吗？
您使用什么约定来评论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)部分写更多内容,给出上下文,但对于大多数的getter/setter,那里的措辞几乎完全相同.
我只是好奇,如果对于简单的getter/setter,只需填写(a)部分或(b)部分即可.
你怎么看？
当我在Netbeans编码时,它自动完成代码并显示Javadocs.但是当我使用Intellij IDEA时,如果我点击Ctrl+Space我可以看到自动完成,如果我点击Ctrl+Q我可以单独看到javadoc.
每当我看到自动完成时,是否有可能看到元素的Javadoc,或者像Netbeans一样点击Intellij IDEA上的Ctrl+Space？
使用Javadoc 1.5,我无法创建枚举值的@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
}
然后使用以下链接引用Javadoc for Earth:
{@link Planet.EARTH}
我也试过这种{@link Planet#EARTH}风格,但无济于事.
有谁知道这是否可行？
如果我<xmlElement>在javadoc中写入,则不会出现,因为标签在格式化文本时具有特殊功能.
如何在javadoc中显示这些字符？
在Netbeans IDE中创建新类或接口时,会出现"@author ...."标记.如何改变它的价值？如果可能的话,我想通过使用Netbeans菜单更改它,而不是通过编辑一些配置文件:)我正在使用Netbeans 7.2提前感谢.