如何生成Java文档注释(Java Doc Comments)
2024-08-24 04:40:17
在我们的Java SDK中已经提供了javadoc工具来生成我们的文档。
所以我们可以手动调用javadoc工具来生成文档,或者通过IDE生成。当然IDE也是调用javadoc,不过更快更省事。
注释的书写方式:https://blog.csdn.net/weixin_43670802/article/details/105612176
javadoc的用法
注意点
我们生成文档主要需要处理的问题有这几个:
- 编码问题,毕竟要处理好中文乱码的糟心事。
- 文档总体语言显示问题,如果不设置地区的话,默认是英语显示的呦,注意不是我们自己写的文档注释,是文档页面总体语言。
手动生成
javadoc -locale zh_CN -charset utf-8 -encoding utf-8 DOCTest.java
-locale zh_CN 地区,决定文档整体页面的语言
-charset utf-8 字符集,解决乱码问题
-encoding utf-8 编码,解决乱码问题
DOCTest.java 目标文件
通过IDEA生成
通过Idea生成也是大同小异,处理好地区与编码就好了。
最新文章
- TCP四步挥手的各种状态转换图
- guava – Optional
- android 进程间通信---bind的前世
- spoj 3871. GCD Extreme 欧拉+积性函数
- hive安装(一)
- php 安装redis扩展
- [algothrim]URL相似度计算的思考
- mysql关键字讲解(join 、order by、group by、having、distinct)
- web并发访问的问题
- Fsu0413's Qt builds
- jeecg智能开发平台参与-2013年度中国优秀开源项目评比
- [ZJOI2006]书架(树状数组水过)
- git 修改用户名和密码
- javascript var变量删除
- linux之tree命令
- 10、JPA-二级缓存
- FTP 其他设置
- PHP json_encode/json_decode与serialize/unserializ性能测
- Spark学习之路 (四)Spark的广播变量和累加器
- IStat Menus 5.02 5.03 的注册码
热门文章
- Java程序设计基础笔记 • 【第9章 方法与参数类型】
- jQuery 中使用 DOM 操作节点,对页面中的表格实现增、删、查、改操作
- 《MySQL数据操作与查询》- 返校复习课练习题,创建数据库user_system,创建数据表user及user_ext
- Spring第一个程序
- gPRC基本介绍
- CAS学习笔记二:CAS单点登录流程
- JZOJ5405 &; AtCoder Grand Contest 001 F. Permutation
- SpringBoot 之 Dao层模拟数据库操作
- org.reflections 接口通过反射获取实现类源码研究
- select 1 from 是什么意思?有什么作用?