现在的位置: 首页 > 综合 > 正文

转:使用eclipse生成文档(javadoc)的方法

2013年10月01日 ⁄ 综合 ⁄ 共 625字 ⁄ 字号 评论关闭

转:使用eclipse生成文档(javadoc)主要有三种方法:

1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。在Javadoc Generation对话框中有两个地方要注意的: javadoc command:应该选择jdk的bin/javadoc.exe destination:为生成文档的保存路径,可自由选择。按finish(完成)提交即可开始生成文档。

2,用菜单选择:File->Export(文件->导出),剩下的步骤和第一种方法是一样的。

 3,选中要生成文档的项目,然后用菜单选择, Project->Generate Javadoc直接进入Javadoc Generation对话框,剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

 

javadoc写法实例:

类开头

/**
*Description: 旨在完成从sgf文件向prefuse需要的xml文件之间的转换
*Copyright: Copyright (c) 2003
* @author derry
* @version 1.0
*/

 

函数开头

 /**
  * 创建一个为prefuse读取所需要的特定xml格式文件,将解析到的棋盘信息写入,
  * 棋盘状态写入nodes节点,棋盘间关系写入edges节点
  * @param filename 文件名
  * @param rootBoard 树数据结构棋盘信息的根节点
  */

 

抱歉!评论已关闭.