注释C代码、头文件和源文件

我正在寻找一个“最佳实践”来记录我的C代码。像在任何项目中一样，我有一些头文件“.h”和相应的源文件“.c”

在头文件中，您输入了什么样的注释？在源文件中呢？ 出现这个问题是因为我对头文件的注释很好，所以c文件看起来很乱

在对代码进行良好注释方面，您的最佳做法是什么？

标题是为代码用户准备的。因此，我在那里记录了接口：如何使用它，先决条件和后决条件，等等

---

c文件是为维护人员准备的。在这里，我记录了实现：事物如何在内部工作，以及它们为什么以这种方式工作。

如果这是一个个人项目，我建议您可以采用很多方法（几乎所有方法都包括如何布置评论的部分）

---

如果没有，我会想象你的公司/teaam/项目已经有了一些东西，所以使用它。

我建议采用像这样的工具强加的约定。然后，您还可以生成HTML/PDF/Latex等文档，而不仅仅是代码注释，它为您提供了良好的约定

---

同意Thomas关于源文件的cpp文件的意见，我建议您为文件头和函数头创建注释模板

对于文件头注释，您应该对文件、函数名、作者、创建日期和历史进行简要描述，以记录修改

---

对于函数头，您可以解释函数和各种参数的逻辑和用途。请确保任何复杂的逻辑或与常见行为的偏差都通过注释得到很好的记录。

当然，注释好标题并不是c文件一团糟的原因……这里可以找到一个类似的问题：我想说，

标题是为代码用户和维护人员准备的。