A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

© 荣斌 中级黑马   /  2015-8-27 21:06  /  15205 人查看  /  56 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

5黑马币
哪位大神可以告诉我文档注释的格式?

56 个回复

正序浏览
/** 文档注释 */ /*多行注释*/ //单行注释
回复 使用道具 举报
//*       */
回复 使用道具 举报
/**
这是一个******的工具类,该类中提供了******等功能。
@author 张三
@version V1.1
*/

//javadoc -d 保存的目录 -author -version ******.java

public class ******
{
        /**
        ------方法说明------
        */
        方法(){}

        /**
        ------说明------
        @param ------说明------
        @return ------说明------
        */
        方法(){}
}

回复 使用道具 举报
//单行注释/**/多行注释
/**
   */文本注释如果要文档注释在文本注释里加@。。。即可
回复 使用道具 举报
//  是对一句进行注释  比如   //这是xxxxx

/*  注释内容  */ 对多句进行注释比如  /*这是一个参数
                                                           这是一个变量
                                                       */      
给分谢谢

回复 使用道具 举报
就是/**文档注释*/
回复 使用道具 举报
IOS开发的话,xcode住的注释最好装个插件,网上搜xcode插件就有了
回复 使用道具 举报
/**注释的文字*/
回复 使用道具 举报
感觉楼主是骗回复的!强烈谴责
回复 使用道具 举报
2楼正解
回复 使用道具 举报
单行注释:
                // 注释文字
        多行注释:
                /*
                        注释文字
                */
        文档注释:
                /**
                        这个是文档注释。它里边的内容可以被JDK的bin目录下的javadoc命令编译成html文件。
回复 使用道具 举报
文档注释格式:/** 注释内容*/
多行注释格式:/*注释内容*/
单行注释格式://注释内容
回复 使用道具 举报
**注释内容*/这样就可以了
回复 使用道具 举报
多行注释:/*文档内容*/
单行注释://文档内容
文档注释:/**文档内容 */
回复 使用道具 举报
/*
*文档注释
*/
回复 使用道具 举报
三人行,必有我师,学习了!
回复 使用道具 举报
/*
*这才是文档注释的标准格式。今天老师刚刚讲的。(这行程序描述)
*@author(这里接作者)
*@version V1.0(v1.0代表版本)
**/
回复 使用道具 举报
文档注释:文档注释是Java里面的一个比较厉害的功能,它可以用于注释类、属性、方法等说明,而且通过JDK工具javadoc直接生成相关文档,文档注释的基本格式为“/**...*/”,不仅仅如此,文档注释本身还存在语法

  [1]文档和文档注释的格式化:

  生成的文档是HTML格式的,而这些HTML格式的标识符并不是javadoc加的,而是我们在写注释的时候写上去的。因此在格式化文档的时候需要适当地加入HTML标签,例如:

/**

*This is first line.<br/>

*This is second line.<br/>

*This is third line.<br/>

**/

  [2]文档注释的三部分:

  根据在文档中显示的效果,文档注释可以分为三个部分,这里举个例子:

/**

*testDoc方法的简单描述

*<p>testDoc方法的详细说明</p>

*@param testInput String 打印输入的字符串

*@return 没有任何返回值

**/

public void testDoc(String testInput)

{

    System.out.println(testInput);

}

  简述:文档中,对于属性和方法都是现有一个列表,然后才在后面一个一个的详细说明,列表中属性名或者方法名后面那段说明都是简述。

  详细说明:该部门对属性或者方法进行了详细说明,在格式上不需要特殊的要求,可以写成前边讲的HTML的格式,如同上边第二行的内容。【*:这里有个技巧就是简述和详细说明尽量不要重复,在简述中出现过的内容不需要在详细说明中进行第二次描述,可以理解为详细说明是简述的一种扩展。后边章节的概念说明代码大部分我都没有写注释,也请各位读者见谅!】

  特殊说明:除开上边的两部分,最后一个部分就是特殊说明部分,特殊说明部分使用JavaDoc标记进行,这些都是JavaDoc工具能够解析的特殊标记,这一点下边章节将会讲到
回复 使用道具 举报
文档开头 /**   
    * 文件名:${file_name}   
    * 版本信息:   
   * 日期:${date}   
   * Copyright 足下 Corporation ${year}     
   * 版权所有     
   */     
对变量的注释/**   
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
*/
对方法的注释
/**   
* 此方法描述的是:   
  * @author: wangxiongdx@163.com   
  * @version: ${date} ${time}   
  */     
对类的注释
/**   
* 此类描述的是:   
* @author: wangxiongdx@163.com   
* @version: ${date} ${time}     
*/     
大概也许可能不全面,你看看
回复 使用道具 举报
注释类容//单行注释                      /* 注释内容*/多行注释
回复 使用道具 举报
123下一页
您需要登录后才可以回帖 登录 | 加入黑马