java程序员需要些什么文档

Question

java程序员在做项目的时候,要写什么文档吗？
还是就知识编码编码再编码/?

Answer 1

我很少写文档，懒得写，除非项目有要求

对于文档这个东西简单谈一下

做项目之前就有文档

这个是可遇不可求的，现在做的项目很多都是临时突然说要做的，什么需求都没有，只能靠程序员自己去发现，项目经理的要求，客户的临时需求（这个比较痛苦，他们有时候根本就不知道要什么，所以必须写好文档，跟客户谈好，不然又要变的时候，你就痛苦了）

如果项目一开始就有文档，当然也可能是你自己写的，也可能是其他人写好的，有些公司有人专门负责写，需求分档，项目分析文档，项目结构文档，数据库文档等等，不过之后可能需要你写测试文档，这个就没有听说过谁帮你做了，但是更多的情况也是不用写，就几个功能，自己和测试人员测测就算了，也有可能需要写使用文档，这个看情况了

做项目之前没有文档

如果项目紧张，根本就不会写任何文档，但是当项目结束的时候，你又没有项目做，项目精灵可能就让你写写文档打发打发时间，

文档对于公司来说是很重要的，但是对于个人的话，就要看情况，如果你做了很多项目，其实什么文档也不需要，你大体上都知道这个项目就做什么用的，怎么架构的，那些代码是什么意思(你的编程习惯很好的情况下)，所以很多公司都会要求程序员写文档，不然你走的时候，别的人怎么接受，让别人理解你的思想是很痛苦的，每个人的思想都是不一样的

Answer 2

目前通用的工具有像apidoc/apidoc，caixw/apidoc 这样的第三方库，虽然具有语言无关的特性，但是真正用起来额外多了很多工作量，而且维护起来麻烦，这也是设计和开发这个工具的原因，想通过 Java 本身的语言特性和结合强大的 IDE ，使得生成和维护 api 文档这件事情变的自然而美好。

Answer 3

程序员也分多种职责的

一般，都要写开发的文档，如详细设计、流程。
如果是设计的程序员，还要做更多，各种设计文档

Answer 4

首先api是必不可少的。