coding-style - 如何编写代码文档架构

Question

我已经搬到新项目，我希望编写解释整个代码的文档，这样如果任何新开发人员加入项目，都可以通过查看文档来理解代码。代码是用 C 编写的，您能否建议文档的技术名称（我不是在制作设计文档，是吗？）以及如何开始使用它。

提前致谢

Answer 1

通常你会称之为“技术设计”。但是，通常您会将内容拆分为多个文档，例如“功能规范”、“高级设计”和“低级设计”（它们共同构成了技术设计）。但这当然取决于您所在的组织。