当前位置: 首页 > news >正文

使用javadoc生成项目的帮助文档

项目的帮助文档更有利于他人对项目的使用。

可以通过cmd命令行和exlipse集成的javadoc功能两种方式制作帮助文档。

cmd命令方式,是使用的是jdk自带的工具,javadoc。打开cmd,如果没有为jdk的bin路径创建环境变量,不可以在任意路径使用javadoc命令,需要到bin目录下使用javadoc命令。

对于一般的制作需求的命令格式是:

javadoc  -d  输出帮助文档的目录  -author  -version  -encoding  源文件编码集  -charset  跨平台查看的编码  -docencoding    输出的编码集

注意,一般java用于开发web项目,默认的编码集都是utf-8的,所以,需要指明源文件的编码集,否则与系统默认的GBK编码冲突,到底是否是utf-8还有视具体情况而论。

例如:javadoc  -d  e:\doc  -author  -version  -docencoding  UTF-8  -charset  UTF-8  -encoding  UTF-8  E:\eclipseworkspace\hello\src\com\tenn\java\xxx.java

关于javadoc更详细的参数,执行javadoc  -help查看。

exlipse中的方式是,file>export>java>javadoc>配置javacdoc命令的文件路径(其实也是使用jdk的javadoc工具)>选择要为哪个或哪些文件生成帮助文档>next>next>在extra  javadoc  options中设置字符编码,基本也是在命令行中设置的参数  -encoding  UTF-8  -charset  UTF-8>finish。


相关文章:

  • [one_demo_13]ArrayList去除重复的元素
  • web项目发布到tomcat的两种方式
  • androidBasic
  • mybatis使用like模糊查询防sql注入写法
  • maven整合ssm项目中报org.apache.ibatis.binding.BindingException: Invalid bound statement (not found)
  • dubbo简介
  • FastDFS简介
  • redis集群
  • solr集群
  • ssm框架web项目配置全局异常处理
  • ActiveMQ
  • 删除数据库重复记录
  • session共享问题
  • springmvc中ajax响应json报406错误的两种原因
  • 数据库切片
  • “寒冬”下的金三银四跳槽季来了,帮你客观分析一下局面
  • 《剑指offer》分解让复杂问题更简单
  • HomeBrew常规使用教程
  • Java比较器对数组,集合排序
  • JSONP原理
  • k个最大的数及变种小结
  • LintCode 31. partitionArray 数组划分
  • Linux中的硬链接与软链接
  • miniui datagrid 的客户端分页解决方案 - CS结合
  • Vue 2.3、2.4 知识点小结
  • vue从创建到完整的饿了么(18)购物车详细信息的展示与删除
  • vue脚手架vue-cli
  • 从伪并行的 Python 多线程说起
  • 订阅Forge Viewer所有的事件
  • 分享一份非常强势的Android面试题
  • 工程优化暨babel升级小记
  • 关于for循环的简单归纳
  • 基于webpack 的 vue 多页架构
  • 聊聊hikari连接池的leakDetectionThreshold
  • 爬虫进阶 -- 神级程序员:让你的爬虫就像人类的用户行为!
  • 区块链技术特点之去中心化特性
  • 深度学习中的信息论知识详解
  • 昨天1024程序员节,我故意写了个死循环~
  • ​插件化DPI在商用WIFI中的价值
  • # C++之functional库用法整理
  • # 安徽锐锋科技IDMS系统简介
  • # 达梦数据库知识点
  • (ZT)薛涌:谈贫说富
  • (附源码)springboot车辆管理系统 毕业设计 031034
  • (附源码)计算机毕业设计ssm-Java网名推荐系统
  • (七)微服务分布式云架构spring cloud - common-service 项目构建过程
  • (数位dp) 算法竞赛入门到进阶 书本题集
  • (淘宝无限适配)手机端rem布局详解(转载非原创)
  • (原創) 如何動態建立二維陣列(多維陣列)? (.NET) (C#)
  • (原創) 物件導向與老子思想 (OO)
  • (转)http协议
  • (转)Mysql的优化设置
  • (转)母版页和相对路径
  • .Net CF下精确的计时器
  • .net core 调用c dll_用C++生成一个简单的DLL文件VS2008