这是一个简单的问题。我正在按照Doxygen的文档记录我的代码，但我有一个问题：我需要在哪里记录？在标题上，在源头上还是两者上？我知道这不是一个规则，但我想知道您对此的看法以及您对代码的操作以及为什么这样做。例如：我正在记录标题，这很好，代码的外观增加了，但是当我查看源（.cpp）文件时，我感到害怕，因为没有文档而且代码不漂亮，我的意思是不是逻辑，而是美（缩进）。而且每个人都知道即使代码不漂亮（在C ++中很难）和文档，它也会变得最酷，更容易阅读。
谢谢大家。 （记住，在你开始写道德课程之前，要知道我知道这不是一个规则，我只是想知道你做了什么）
答案 0 :(得分：3)
我个人更喜欢用这种东西记录h文件。需要使用您的API的人可能需要您的标题，但不是您的cpp。没有标题，人们永远不会需要你的cpp。将文档保存在需要它的每个人都可以获得的地方。