Question

java面试官问有没有写过文档（面试java程序员）,我想知道写文档是指什么,是设计文档还是需求文档还是其他

还有，在企业里面试官所指的文档要怎么写，大概步骤和流程是什么样子的

Answer 1

我想他的文档是指在项目开发过程中 不同阶段的文档

我们项目组开发基本是基于瀑布模型开发 每个阶段都会输出文档指导后续工作开展
一般se下发需求后 由我们出 详细需求设计文档
代码开发完成了 转测试时我们会写 数据库设计文档 ，操作手册 (这个也算)
还有就是 版本升级说明书 版本功能清单 软件介绍
这个是大概的文档 还有其他的...文档编写时间 主要是代码开发前 与 转测试后

追问

你说得好复杂啊 se下是什么意思

追答

额..确实有点 其实就是他们上面说那些一般是
需求设计文档(就是自己写怎么实现这个需求)
然后就是
数据库文档(如果有数据库表的设计这些)
操作手册(我们是页面系统 需要写这个)
升级指导说明书(指导运维人员升级用的)
版本功能清单(这个版本的功能介绍)
还有些杂七杂八的 就不说了 免的弄晕你了

Answer 2

java文档通常指注释文档，是通过在源代码中以注释的方式书写，使用javadoc命令生成的文档文件，用于协助其他程序员阅读你的代码结构，尤其是复杂的类功能和方法使用要点。

写程序加文档是好习惯。
我是通过李刚老师的《疯狂Java讲义》学习的文档书写方法。在第三章开头。建议你买一本看。

追问

我就在看

Answer 3

一般大点的公司需求文档还是不需要你去编写的，不过需要开发人员协同讨论与审批，
一般开发人员要写的是 概要设计文档，和详细设计文档之类的
至于步骤要看公司而定，有的是开发完成后才去补写这样的文档，有的是在开发前就需要
将文档写好，然后按照文档来开发。

追问

谢谢

Answer 4

注释文档吧。

追问

注解文档是什么？

追答

打错了，注释文档

追问

注释文档什么步骤，说通俗一点啦，

追答

我不是太熟，
就是在类和方法前用
/**
* @throws NamingException
*/
的注释，用来标识类和方法的用法，参数返回值之类，比如上面的就是说这个方法可以抛出这个异常，注释文档可以用javadoc这个程序直接生成HTML的API文档
你用Google 搜索注释文档，有一大堆结果

追问

就是这个啊？不是这样的，谢谢你