未使用 Doxygen 记录变量

发布于 2025-01-06 21:34:24 字数 317 浏览 0 评论 0原文

我正在使用 Doxygen 来记录我的 C++ 代码。所有内容都以 HTML 格式很好地输出，除了像下面这样的属性/变量不是（根本不是）。

    /**
     * Flag to check whether the variable is once initialized or not
     */
     bool initialized_;

知道会出什么问题吗？

编辑

initialized_ 是一个类成员变量。

原文

I'm using Doxygen to document my C++ code. All are well outputted in HTML format, except attributes/variables like below are not(not at all).

    /**
     * Flag to check whether the variable is once initialized or not
     */
     bool initialized_;

Any idea what could go wrong?

EDIT

initialized_ is a class member variable.

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

莫多说 2025-01-13 21:34:24

我不确定这是否能解决您的问题，因为您提供的有关变量 initialized_ 的信息非常少（它是全局变量吗？它是类的一部分等），但是 doxygen < a href="http://www.doxygen.nl/manual/docblocks.html" rel="nofollow noreferrer">文档（请参阅标题其他地方的文档）指出那

要记录 C++ 类的成员，还必须记录该类本身。这同样适用于命名空间。要记录全局 C 函数、typedef、枚举或预处理器定义，您必须首先记录包含它的文件（通常这将是头文件，因为该文件包含导出到其他源文件的信息）。
让我们重复一遍，因为它经常被忽视：要记录全局对象（函数、typedef、枚举、宏等），您必须记录定义它们的文件。换句话说，至少必须有一个
<前><代码>/*！ \文件 */
或者
<代码>/** @file */ 
此文件中的行。

I'm not sure if this will solve your problem, since you have given very little information about the variable initialized_ (is it a global variable, is it part of a class etc.) but the doxygen documentation (see under the heading Documentation at other places) states that

To document a member of a C++ class, you must also document the class itself. The same holds for namespaces. To document a global C function, typedef, enum or preprocessor definition you must first document the file that contains it (usually this will be a header file, because that file contains the information that is exported to other source files).
Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a
/*! \file */ 
or a
/** @file */ 
line in this file.

回复收藏 0 原文

老娘不死你永远是小三 2025-01-13 21:34:24

这也可能有助于人们寻找答案：

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.

RECURSIVE              = YES

在您的 Doxyfile 文件中，

我使用 doxygen 和 Doxygen GUI Frontend (Doxywizard) 版本 1.8.9.1对于 OS X。还有一个可以启用的递归扫描复选框。默认情况下未启用此功能。

./doxygen -x
error: Unknown option "-x"

This might also help people looking for answers:

# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.

RECURSIVE              = YES

in your Doxyfile file

I am using doxygen and the Doxygen GUI Frontend (Doxywizard) version 1.8.9.1 for OS X. There is also a checkbox for scanning recursively you can enable. This was not enabled by default.