C/C++头文件，文件[封闭]

Question

你认为什么是最佳做法在创建公头文件中的C++？

1. 应该标题的文件没有包含简短或大量的文档？我看到的一切几乎没有任何文件(依靠一些外部文件)，大规格的变量，有效的参数，返回值等。我不知道到底是什么我更喜欢大型的文件是很好的因为你一直对它的访问从你的编辑，在另一只手头文件中有非常简短的文件常常可以显示一个完整的口在一个或两页的文字给人一种更好的概述，有什么可以做一类。

2. 我们说我去的东西一样简单或大量的文档。我想要的东西，类似于如果是的话，为什么不试我的文档返回值、参数等等。什么是最佳的公约》，在c++？我记得doxygen不好的东西与java doc式文件，但是没有任何其他公约和工具，为此，我应该意识到之前，如果是的话，为什么不试式文件？

Answer 1

通常我把文件接口(参数，返回值， 什么样的 功能不会)的接口文件(.h)和文件的执行情况(如何 功能不会)在执行文件(.c.cpp.m)。

我写的概述类只是在其《宣言》，使读者具有立即的基本信息。

该工具，我用的是Doxygen.

Answer 2

1. 我将依旧有的一些文件在标题文件本身。它大大提高了试有的信息下来的码，而不是在单独的文件。作为一项规则的拇指，我会文件API(返回的价值观、参数、状态的变化，等等)接下来的码，以及高水平的建筑概述在单独的文件(得到更广泛的角度了解的一切都放在一起；很难把这一起码的，因为它通常引用的几类在一次)。

2. Doxygen是现在从我的经验。

Answer 3

我相信Doxygen是最常见的平台产生的文件，并尽我知道的，它或多或少能够涵盖如果是的话，为什么不试-notation(不限于为然)。我用doxygen为C，以确定结果，我认为它更适合用C++虽然。你可能会想要看到机器医生好，虽然我认为奥卡姆剃刀会告诉你而去Doxygen.

关于如何从文件，我从来没有一个文件-扇我自己,但我是否喜欢还是不喜欢，有更多的文件总是比没有文件。我会把阿文的文件标题的文件和执行文件的执行情况(理，不是吗？).:)这种方式，IDEs有机会把它捡起来，显示它在自动完成(蚀为JavaDocs，例如，也许还为doxygen?), 这不应该被低估。如果是的话，为什么不试有这种额外的怪癖，它使用的第一句(即第一句)作了简要说明，不知道如果Doxygen这虽然，但是，如果是这样，它应考虑到当编写的文件。

有很多文件的危险正在出日期，但是，保持本文件附近的码将给人们一个机会保持它迄今为止，所以你应该肯定保持它的源/头文件。什么不应该忘记，虽然所生产的文件。是的，有些人会使用的文件直接(通过IDE或什么的，或只读标题文件)，但是有些人更喜欢其他的方式，所以你也许应该考虑把你的(定期更新)API文件的在线，一切都很好，可浏览，以及或许产生的人文件，如果你的目标*尼克斯的基于开发人员。

这就是我的两个美分。

Answer 4

投入足够的代码，它可能独立。几乎每一个项目，我已经在那里的文件是独立的，它得到了日期，或者没有这样做，部分是，如果它是一个单独的文件就变成一个单独的任务，部分原因是管理不允许它为任务在预算.记录内联的一部分流工作得更好的在我的经验。

编写文件的形式最多的编辑人员认识到一块；C++这似乎是/*而不是//.这样你可以把它折叠和刚刚看到的声明。

Answer 5

也许你会感兴趣 gtk-doc.它可以是"一个有点尴尬安装和使用"，但你可以得到一个很好的API文件的源代码，寻找这样的：

串的实用功能