eclipse导出doc

本文介绍了解决Eclipse导出DOC文档时出现乱码的问题,通过在导出设置中添加-javadoc.exe参数-encodingUTF-8-charsetUTF-8来确保文档正确编码。

今天发现eclipse导出doc文档的时候有乱码问题,查看了一下资料,应该在Extra Javadoc option,也就是最后一步的时候增加javadoc.exe运行的参数

-encoding UTF-8 -charset UTF-8

 

没有什么难度,记录一下,以后用上好查看。

### 如何在 Eclipse 中编写和使用 Java 文档注释 #### 编写文档注释 为了使 `javadoc` 工具能够识别并生成有用的 API 文档,应当遵循特定格式来书写文档注释。这种注释以 `/**` 开始,并以 `*/` 结束[^3]。 对于类、接口、成员变量以及方法的描述,推荐采用如下结构: ```java /** * 描述该元素的作用。 * * @param 参数名 对应参数的意义解释 * @return 返回值含义(仅限于方法) */ ``` 例如定义一个简单的加法函数时可这样添加注解: ```java public class Calculator { /** * 计算两个整数之和。 * * @param a 第一个加数 * @param b 第二个加数 * @return 两数相加之和 */ public int add(int a, int b){ return a+b; } } ``` #### 使用快捷键创建模板 为了让开发人员更加高效地工作,在 Eclipse IDE 下提供了方便的方式来快速插入上述样式的框架。默认情况下,“Source”菜单下的“Generate Element Comment”选项可以帮助完成这项任务;另外也可以自定义全局范围内的热键组合用于触发此功能[^5]。 进入设置界面路径为:“Windows -> Preferences”,接着定位到 “General -> Keys”。在这里查找名为 "Add Javadoc comment" 的命令,并为其指定一个新的加速按键配置方案即可实现个性化定制化需求。 #### 生成 HTML 格式的帮助文件 当项目中已经包含了足够的文档注释之后,就可以考虑将其转换成易于阅读的形式了——即HTML页面形式的帮助手册。这一步骤可通过两种途径达成目的:一种是从项目的上下文菜单里选取“Project->Generate Javadoc...”;另一种则是借助导出向导完成相同的操作流程:“File->Export...->Java->Javadoc”。 执行过程中需注意的是,默认状态下只会针对公开(`public`)级别的组件进行处理,若想让私密级别(`private`)的内容也出现在最终产物之中,则记得勾选相应的选项开关^-private^。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值