哪种注释方法能够支持javadoc命令
2015-08-06 · IT·互联网经理人培训口碑品牌
关注
展开全部
文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释慎旦姿的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在宽绝语法:
1. 文档和文档注释的格式化:
生成的文档是HTML格式的,而这些HTML格式的标识符并不是javadoc加的,而是我们在写注释的时候写上去的。因此在格式化文档的时候需要适当地加入HTML标签,比如,需要换行时,不是敲入一个回车符,而是写入,如果要分段,就应该在段前写入。
2. 文档注释的三部分根据在文档中显示的效果,文档注释分为三部分迟尘:
第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
1. 文档和文档注释的格式化:
生成的文档是HTML格式的,而这些HTML格式的标识符并不是javadoc加的,而是我们在写注释的时候写上去的。因此在格式化文档的时候需要适当地加入HTML标签,比如,需要换行时,不是敲入一个回车符,而是写入,如果要分段,就应该在段前写入。
2. 文档注释的三部分根据在文档中显示的效果,文档注释分为三部分迟尘:
第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
推荐律师服务:
若未解决您的问题,请您详细描述您的问题,通过百度律临进行免费专业咨询