如何不花一分钱就能完成详细的设计规范（Java系统）

程序员最痛苦的事情: 1.其他人不写文档，2.其他人不写注释，3.写文档，4.写注释. 我在上一个博客中谈到了这个问题，但是让程序员自己大胆地做同样的事情. 我相信99％的人会选择写评论而不是写文档. 毕竟，注释仍然是程序的一部分，您不需要打开不幸的单词.

目前，我不会讨论为什么开发人员对文档如此强烈的抵抗. 本文主要讨论如何解决最困难且最无用的软件过程文档-软件详细的设计说明. 当然，本文不仅讨论技术问题，还讨论管理问题. 如果您的前任老板不同意更改模板，则本文的方法不可实施.

常规软件过程文档包括:

需求规格->概要设计->详细设计->确认测试计划->确认测试描述->确认测试报告->总结

从这个序列中，您可以看到从流程到详细设计的详细意图是指导特定的开发工作，但是在这个时代，我相信，除了极少数领域的公司或组织，它尚未得到开发. 根据标准瀑布工艺. 被蒙住眼睛的东西在大多数时候都没有用. 此时，先要求再设置然后再设置的过程太麻烦了. 与需求规范的需求跟踪功能相比，轮廓设计是针对体系结构的. 指导，详细的设计代码几乎为零. 因此，详细设计的业务价值几乎为零，但是相应的数百页的规模却不是普通人可以阅读的. 即使阅读了它，也不太可能记得前100页所说的内容. 因此，对于开发人员而言，详细的设计是最麻烦，最不愿意的文档.

我相信大多数传统公司都会有自己的模板，用于详细的设计说明，并且这些模板应该相似. 如果我们想完成详细设计规范的自动化，那么我们需要开发团队有权通过将模板调整为可以自动生成的样式来对模板提出修改建议.

使用Javadoc和一系列工具基于代码完成文档的自动生成，并将自动生成的文档用作详细设计规范的主要部分，然后复制大纲设计的核心部分，如体系结构，数据流和接口等，在详细描述中的描述部分是为了完成详细设计规范的准备.

公司文件无法更改，我们必须使我们的改进合法合理. 我们的路线如下:

1. 首先必须分析公司模板以确定核心内容

2. 收集原始模板详细设计规范的人工和时间成本数据

3. 进行自动生成实验并计算所需时间

4. 找到相关的利益相关者，直接领导，质量保证人员和其他人员，显示数据差异并自动生成样本并获得批准.

5. 通过一个小项目进行试验，以验证其成熟度和可行性.

6. 改善和促进.

1. 相关文档将通过javadoc自动生成. 我们通常使用IntelliJ Idea进行生成，如下所示.

如果遇到字符集问题，请在参数中添加-encoding utf-8 -charset utf-8

自动生成javadoc后，通常我们可以在输出目录中看到这样的结果

打开index.html，您会看到类似这样的界面

通常，如果仅需要文档的电子版本，则可以执行此步骤，但是如果需要纸质版本，则需要进行下一步.

2. 将javadoc转换为其他可打印格式

2.1至chm

jd2chm工具可以将javadoc生成的html转换为chm文档. 我使用的是0.34版本

启动jd2chm代码详细设计文档，出现以下命令行界面

按照提示设置javadoc路径和其他基本配置以生成chm文件. 成功后，javadoc文件夹将如下所示

CHM类型文件是最后生成的文件，可以通过打印功能完成chm打印，但是此方法存在一个问题，即javadoc必须使用特定的模板，并且不允许使用默认模板.

2.2 HTML合并

通过htmlDoc工具将生成的html文件合并为单个doc或pdf，以便可以轻松保存和打印.

1）下载并安装此工具，网址:

2）打开程序并添加要生成的html

3）配置输出路径

4）点击生成

此解决方案的缺点不利于中文支持，可能会有乱码

2.3自行开发的转换工具

实际上，转换过程并不复杂. 如果要生成喜欢的格式和模板，可以投入一些人力来开发自动转换工具.

本文详细讨论了如何设计自动化的问题. 实际上，主要问题是管理意识. 如果老板或盲目的请求是根据现有模板编写的，请随心所欲.

这种方法在实践中会遇到很多问题. 如果您对练习感兴趣，不妨参考我们的路线代码详细设计文档，以免移动太多.

本文来自电脑杂谈，转载请注明本文网址：
https://www.pc-fly.com/a/jisuanjixue/article-264741-1.html