c++ - 我应该把文档注释放在哪里？

Question

这个问题在这里已经有了答案:

Where to document functions in C or C++? [closed] (10 个回答)

关闭 3年前。

锁定。这个问题及其答案是 locked因为这个问题是题外话，但具有历史意义。它目前不接受新的答案或交互。

在包含前向声明的头文件中，还是在包含实现的 .cpp 文件中，像这样？

//header.h
/* About foo() */
void foo();
/* About bar() */
int bar();
/* About A */
class A
{
public:
    /* About A's constructor */
    A();
    ....
}

或者

//implementation.cpp
/* About foo() */
void foo()
{
    ...
    ...
}
/* About bar */
int bar()
{
    ...
}
/* About A's constructor */
A::A()
{
    ...
}

Answer 1

有关使用信息，最好放在标题中。这是人们首先看的地方。

如果没有人必须检查您的 .cpp 文件来确定应该如何使用该组件，那么该文档是非常成功的。