记录代码头和源代码[关闭]答案

【问题标题】：Documenting code header and source [closed]记录代码头和源代码[关闭]
【发布时间】：2014-03-26 12:10:02
【问题描述】：

这是一个简单的问题。我正在按照 Doxygen 的文档记录我的代码，但我有一个问题：我需要在哪里记录？在标题上，在源上还是在两者上？我知道这不是一条规则，但我想知道您对此的看法以及您对代码所做的事情以及您这样做的原因。例如：我在记录header，很好，代码的外观增加了，但是当我看到源（.cpp）文件时，我很害怕，因为没有文档，代码不漂亮，我的意思是，不是逻辑，而是美（缩进）。并且每个人都知道，即使代码不漂亮（这在 C++ 中很难），但它会变得最酷且更易于阅读。

谢谢大家。（记住，在你开始写道德课之前，要知道我知道这不是规则，我只是想知道你在做什么）

【问题讨论】：

Where to put the doxygen comment blocks for an internal library - in H or in CPP files?的可能重复
Stack Overflow 真的不是征求主观意见的地方。
在一个完美的世界里，人们不应该阅读源代码。因此，将 doxygen cmets 放在更改关联代码时更容易更改的地方。
我个人在标题中执行此操作，您在查询某个类的接口时最有可能阅读该标题。好吧，这可能会触发重建，但如果你正在修改文档注释，那么很有可能你的函数的先决条件已经改变，在这种情况下重建可能不是一件坏事。

标签： c++ c++11 coding-style documentation doxygen

【解决方案1】：

我个人更喜欢用这种东西记录 h 文件。需要使用您的 API 的人可能需要您的标头，但不需要您的 cpp。如果没有标头，人们将永远不需要您的 cpp。将文档保存在每个需要它的人都能得到的地方。

【讨论】：

虽然看了stackoverflow.com/questions/355619/…之后我不太确定。