Java入门第71课——规范注释及文档生成(Eclipse)

问题

        请看下列代码，其作用如下：

        1)类JavadocTest的作用是用于测试生成Javadoc文档；作者为monkey;版本为1.0。

        2)方法hello的作用为获取打招呼字符串；该方法的参数name表示指定向谁打招呼；该方法返回打招呼的字符串。

    package day01;
    public class JavadocTest{
        public String hello(String name){
            return name+",你好!";
        }
    }

        使用文档注释，为上述代码添加注释，并生成Javadoc文档。

步骤

        实现此案例需要按照如下步骤进行。

步骤一：为代码添加文档注释

        根据问题的描述，使用/**  */为代码添加注释。代码如下所示：

    package day01;
    
    /**
    *<strong>JavadocTest</strong>类用于测试生成Javadoc文档
    *
    *@author monkey
    *@version 1.0
    */
    public class JavadocTest{
        /**
         *获取打招呼字符串
         *
         *@param name
         *        该参数指定向谁打招呼
         *@return 返回打招呼的字符串
         */
         public String hello(String name){
             return name+",你好!";
         }
    }

步骤二：使用Eclipse生成文档注释

        首先，点击Project-->Generate Javadoc,如图-1所示。

        点击Generate Javadoc以后，进入下一界面，选择你要生成Javadoc的包，或包下的类以及生成的Javadoc所存在的路径，默认生成到当前工程目录下，如图-2所示。

        点击Finish，即可生成Javadoc。生成的Javadoc文件如图-3所示：

        点击index.html，查看具体内容，如图-4所示。

想找个老师带你学习Java?--->http://java.itkzhan.com/Public/index