很多人第一次写开发技术文档都不知道怎么写，该写些什么东西。个人认为技术文档格式是次要的，它的主要目的是给以后提供项目制作的思路。那么java开发文档怎么写?摆着一个着眼点页面的流转，业务的处理，逻辑都要很好的记录下来。
java开发文档怎么写？
Java文档注释是用于生成Java API文档的注释，通过在程序中的类、属性、方法部分加上注释，就可以用javadoc命令生成漂亮的API文档，是程序员进阶的必备技能。
注意，文档注释只说明紧跟其后的类、属性或者方法。
Javadoc文档生成命令为：
-author和-version可以省略。
文档注释的结构
根据在文档中显示的效果，文档注释分为三部分。举例如下：
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号).
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，雅思周末班在格式上没有什么特殊的要求，可以包含若干个点号。它在文档中的位置如下图所示：
这部分文档对应的代码是：
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置：
除上面所写之外，还有javadoc命令等详细参数没有介绍，请自行在命令行中使用help命令查看。
关于生成Java文档，通过命令行进行生成通常只做演示的作用，我们开发所使用的IDE如：IntelliJ IDEA、Eclipse等均集成了文档生成功能，只需要我们把文档注释写好，然后点击按钮即可。
福利时间：我整理了一些技术资料和面试题集，供大家提升进阶，不管你是有跳槽打算还是单纯精进自己，都可以免费领取一份。
先展示部分截图，文末附免费下载方式
一、JVM篇(2022)
(含：JVM类加载机制，JVM内存模型，垃圾收集机制，类字节码实现机制，JVM调优案例，GC日志详解等)
二、Java并发编程(2022)
(含：java内存模型，并发集合，线程池，阻塞队列，CAS与原子操作，无锁并发框架Disruptor等)
三、Spring篇(2022)
(含：spring IOC，spring AOP原理，spring 5，springMVC，事务管理，循环依赖，spring设计模式等)
四、Mysql篇(2022)
(含：SQL执行原理，索引底层机制，SQL执行计划分析，Mysql锁机制，Mysql事务隔离，SQL优化实践等)
五、SpringCloud篇(2022)
(含：服务发现与注册Eureka与Nacos，服务限流熔断降级Hystrix与Sentinel，分布式事务Seata，网关Gateway等)
六、Dubbo篇(2022)
(含：Dubbo基础，架构设计，集群，配置，通信协议，SPI等)
七、Redis篇(2022)
(含：Redis核心数据结构，Redis持久化机制与安全机制，哨兵与集群架构，Redis缓存穿透，缓存失效，缓存雪崩，Redis缓存设计与性能优化等)
八、分布式篇(2022)
(含：分布式架构原理，集群架构原理，分布式锁，分布式事务，分布式协议，分布式配置，海量数据分库分表，分布式调度，等)
九、设计模式篇(2022)
(含：单例模式，工厂模式，抽象工厂模式，建造者模式，原型模式，适配器模式，装饰器模式，代理模式等23种设计模式)
十、数据结构与算法篇(2022)
(含：红黑树，B+树，贪心算法，哈希分治法，七大查找算法，动态规划，一致性算法等)
十一、MQ篇(2022)
(含：消息丢失，消息重复消费，消息乱序，消息积压，延时队列，消息回溯消费，消息刷盘机制，MQ中间件集群架构原理等)
十二、Netty篇(2022)
(含：BIO、NIO及AIO线程模型，Netty线程模型，序列化协议protobuf，粘包拆包问题，Netty心跳机制，直接内存与Netty零拷贝，WebSocket协议等)
十三、Zookeeper篇(2022)
(含：ZooKeeper选举机制，ZooKeeper数据模型，ZooKeeper应用场景等)
十四、ElasticSearch篇(2022)
(含：ElasticSearch数据模型、ElasticSearch分布式架构、ElasticSearch数据读写原理和段合并等)
十五、网络与操作系统篇(2022)
(含：网络协议，TCP/IP系统结构，TCP/IP协议族，常见面试题，等)
