C语言中的项目设计文件

Question

我有一些用面向对象语言开发的项目设计文档化的经验。当我使用OOP语言时，我创建了类并使用类图来展示实现的总体设计结构。

问题:我即将用C语言开始一个项目。现在我该怎么写设计文档呢？

设计文档不应该独立于实现语言吗？但是，在没有涉及到我的实现的情况下，我无法弄清楚我将如何和如何显示关系？

问:有什么标准的方法来记录C项目吗？

我完全搞不懂我到底应该在设计文件中显示什么？功能？我该怎么联系他们？

是否会欣赏到任何开源C项目的链接，其中可能有这样的文档可供参考？

P.S.：项目是C语言的最小内核开发。

Answer 1

用类和对象正常地编写设计文档。

C仍然有用户定义的数据类型:它们只是用struct关键字而不是class来声明。

C仍然有封装和数据隐藏:您只是没有private关键字来使编译器为您强制执行它。将在相同数据类型上操作的函数分组到一个模块中，只是不公开该模块之外的私有数据。

如果你真的想要的话，C仍然可以有抽象，甚至继承(尽管这是一项很大的工作，除非你确信它是必要的)。

在实现时，您必须决定如何实现这些类和对象。

类可以实现为struct加上方法的相关函数云。除了失去一些语法糖，它也是一样的，除非你需要多态。

Answer 2

设计文档不应该独立于实现语言吗？但是，在没有涉及到我的实现的情况下，我无法弄清楚我将如何和如何显示关系？

通常，一个建筑设计将独立于语言，尽可能。如果预先作出了任何技术决定，则可以将其包括在系统架构中。详细设计倾向于考虑开发语言，以便所使用的符号与构建和/或维护系统的人员相关。如果您正在创建一个详细的设计，并且您知道应用程序将用C编写，请使用C中的术语和构造。

有什么标准的方法来记录C项目吗？

有很多方法来记录C项目。可以使用UML中的一些构造，记住一些面向对象的术语不适用，因此不应该使用。类图、活动图、组件图和序列图可以在不同程度上使用，通常使用完整UML语言的子集。或者，可以使用数据流图、数据结构图或JSP图。文本表示(包括在实现算法之前创建伪代码)也是有效的。

要记住的是设计文档的目的。所有的设计文件都应该说明系统将如何满足需求。剩下的取决于观众。如果您要设计和实现系统，那么这些文档可以作为未来开发人员和测试人员的指南。如果您只是在设计系统，您需要在输入和输出方面更加明确，这样，只考虑到系统的模型和描述，某人就可以构建一些满足您需要的东西。