我工作的公司不使用Doxygen，并且在他们的编码标准中明确禁止“可解析的注释样式，如javadoc等”。然而，我仍然发现自己运行Doxygen是非常有用的，这样我就可以看到类的结构，并获得类所拥有的所有方法的每个类的文档，包括继承的方法。该公司确实在头文件中记录了这些类，并在每个方法声明的上方添加了简单<em
浏览 10提问于2020-07-30得票数 0
回答已采纳
我正在使用Doxygen和一些内嵌的C源代码。给定一个.c/.h文件对，您是在函数原型(.h文件)上还是在函数定义(.c文件)上放置Doxygen注释，还是在这两个位置都复制它们？我遇到了一个问题，当我在一个地方而不是另一个地方记录文档时，Doxygen会警告我遗漏了注释</
浏览 9提问于2009-08-13得票数 26
2回答
我有一个用C++编写的项目，在该项目中，我还使用swig生成一些C#包装器。C++代码使用Doxygen注释来注释类和函数。能让Swig接受这些doxygen注释并为C#包装类和函数生成doxygen注释吗？
浏览 9提问于2016-06-13得票数 6
使用VisualStudio2019和C# (以及Doxygen的新版本)。基类方法中的Doxygen注释是否可能在派生类的Intellisense中“应用”(而不必为派生类本身中的方法编写Doxygen注释块)？基类注释“关于这个酷函数的东西”可以显示吗？目前显示的是基本的原型信息，但没有其
浏览 8提问于2021-07-22得票数 1
回答已采纳
3回答
我使用Doxygen为我的目标c代码生成文档。然而，到目前为止，我还没有找到任何关于如何正确地记录属性的指导原则。我已经看过的例子可以用任何可以想到的方法来实现。一些使用//，而另一些使用完整的/** */块。
有没有人能给我一个最佳实践的参考资料？或者是关于未来与Doxygen的
浏览 0提问于2010-03-05得票数 9
回答已采纳
我正在使用Eclipse CDT编写C++代码。在StackOverflow上阅读了几篇关于是否将doxygen文档放在头文件或实现文件中的讨论后，似乎大多数开发人员倾向于将doxygen注释放在头文件中(当然，这并不是一个共识)。但是，如果我将doxygen注释放在头文件中，当我将鼠标指针悬停在已注释的方法/成员的实例上</e
浏览 6提问于2011-06-23得票数 28
我认为正确的方法是使用\param、\return和\brief来doxygen .h函数原型，因为这样会隐藏实现，并且只向包含.h文件的函数公开API；并且doxygen会使用更多\详细信息来doxygen.c函数实现。这也是关于stackoverflow的建议。
有没有可能告诉doxygen将.c和.h文档结合起来？因为.c实现可以是一个<e
浏览 2提问于2014-06-14得票数 3
1回答
我有以下功能原型：我用doxygen记录的。现在我有了一个重载的函数版本，它也是这样做的，所以我想复制doxygen注释，如下所示：bool key_pressed(char key) const;
这不起作用
浏览 1提问于2010-08-22得票数 0
回答已采纳
我目前使用doxymacs来语法高亮显示C++文件中的doxygen注释和关键字，这是我正在进行的一个协作项目。然而，在这个项目中，有一些“计划”文件，这些文件基本上都是非常长的doxygen注释，带有大量的todos、bug等内容，所有这些文件都使用html标签来组织和呈现。目前doxymacs只突出显示"todo“和"bu
浏览 0提问于2011-07-17得票数 2
回答已采纳
1回答
我试图使用doxygen为我的C应用程序生成文档，但只为宏(#define)生成文档。输入头文件同时包含宏和一些函数原型，但我不希望DO2为原型生成文档。这就是问题所在。如何仅用宏生成文档？我已经尝试了很多选择。EXCLUDE_PATTERN不起作用，因为有一些宏和原型总是有一个共同的模式，而且一个独特的模式在将来可能并不是唯一的。我</
浏览 3提问于2013-11-28得票数 0
回答已采纳
我正在写一个C/C++程序。程序的树形结构如下： |---- lib1 |----include |----src |---- app1 |---- app2App1和app2是使用lib1和lib2的两个应用程序我已经在lib1和lib2中记录了头文件。然
浏览 0提问于2017-09-19得票数 0
在哪里可以找到允许签订合同的doxygen标签列表？此外，还有另一种名为natspec注释的注释，文档尚未为其编写。. */)编写的，它们应该直接用于函数声明或语句之上。您可以在这些注释中使用DO2样式的标记来记录函数，注释用于正式验证的条件，并提供一个确认文本，当用户试图调用某个函数时，该文本将显示
浏览 0提问于2018-06-18得票数 8
回答已采纳
1回答
我有这样的东西( 文档中的例子)：//! Enum doc NoOptions = 0x0, //!Value doc ShowAll = 0x2,Q_DECLARE_FLAGS(Options, Option)
现在我可以记录Option及其值，doxygen将很好地显示它们。但是我不能让doxygen
浏览 0提问于2018-01-25得票数 4
回答已采纳
我刚开始用Objective-C编程，发现了一些示例注释，如下所示：*/
@brief的用途是什么？这是不是与Doxygen这样的文档系统有关？
浏览 0提问于2012-05-29得票数 6
回答已采纳
2回答
我使用doxygen生成xml，然后将其转换为自定义文档。在java和c#中注释都被忽略。例如：{ string UserName {get;set;} doxygen中没有解析/显示“必需的”注释<em
浏览 0提问于2014-11-13得票数 0
1回答
我必须用C编写一些代码，所以我决定学习doxygen (和subversion)。 /*!我发现了一些捷径，但这是随机的。上面线程中<em
浏览 2提问于2014-06-22得票数 0
1回答
我在c++上编程时使用Eclipse。我使用的代码提供了大量的doxygen注释。我希望能够在eclipse中看到它们，而不必使用外部浏览器。我认为javadoc的等价物是shift+F2，但它不适用于c++ doxygen。换句话说，当我的鼠标悬停在类的方法上</e
浏览 2提问于2012-04-10得票数 11
我想写一个Doxygen注释来命名出现该注释的文件。我不想显式地写出文件名，而是希望Doxygen为我提供文件名。因此，如果我更改了文件名，或者将一些内容移动到不同的文件中，则不需要更改该名称的硬编码实例。举一个具体的例子，假设我正在向array.hpp中的函数添加注释，并且我希望某些
浏览 2提问于2016-07-22得票数 2
我在Eclipse Helios上的一个PHP项目中使用了Doxygen和Eclox插件。几乎一切都很好，但是：* @param typename $parametername* @param $parametername [typename]
(实际上，据我所知，Doxygen并不知道PHP中的
浏览 3提问于2011-04-12得票数 0
我使用的是Eclipse (Mars2) Doxygen、Eclox和PDT。我注释了一些代码： * @fn __construct($a, $b) * @details blablabla* @param Boolean $a blablabla */
在Doxygen</em
浏览 0提问于2016-05-31得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
腾讯会议
云直播
对象存储活动推荐
腾讯云开发者
