| 留言与评论（共有 0 条评论） |
编程序要写文档，那么这个文档要怎么写呢？应该包括什么内容呢？是不是就是关于这个软件怎么使用？
发布时间：2020-04-15 16:49:07
程序的文档主要包括：架构设计、数据库设计、用例图、时序图等等，而你所说的使用文档是由其他文案工作人员完成的。
我正在惨遭写文档的蹂躏。首先要有一个简介，说说你这玩意是干啥用的，怎么安装，依赖哪些东西，怎么联系作者。然后可以有一个详细的说明，主要是你这个东西的设计，总体结构是什么样的。最好有一步一步的教程。最后，也是最基本的内容，API的说明。你的库里每一个类型、函数、全局变量的作用、输入输出等等。这个可以按特定的格式直接写在源代码的注释里面，用Doxygen自动提取出来。有些语言自带文档系统，比如Perl的perldoc。那么就得按照它的传统习惯来做。
相关内容推荐：
- 话题列表
- 推荐阅读
-
- 优质推荐
全站搜索