标签: doxygen

我想在Visual Studio 2010中对C++语言的注释中使用魔法语法着色.例如,我有以下代码:

/*!
      \sa testMeToo()
      \param a the first argument.
      \param s the second argument.
*/
int testMe(int a,const char *s);

在Visual Studio中,所有\ param,\ sa和其他Doxygen命令都不会突出显示.是否可以向Visual Studio添加自定义突出显示？

至于我,这种C++注释的理想语法突出显示在Anjuta(GNU/Linux C++ IDE)中.

谢谢.

UPDATE

我为Visual Studio 2010/2012 编写了EnhancedCommentsCpp插件,它突出显示了Doxygen命令:

http://visualstudiogallery.msdn.microsoft.com/11a30c1c-593b-4399-a702-f23a56dd8548

这是它的样子:

我正在研究C++和Objective C iPhone项目.我正在使用git作为我的版本控制系统.

代码库已经增长了很多,所以我想将doxygen添加到项目中.问题是我不确定这样做的最佳方法是什么.

我考虑过几个选项:

1)在项目文件夹中创建doxygen HTML文档,并使其成为项目的"部分",以便它也被版本化并提交给git.

2)在项目文件夹中创建doxygen HTML文档并将其添加到项目中,.gitignore因此项目的每个用户都负责生成文档,项目git存储库将保持不变(除了.gitignore).

我们在主服务器中使用git --bare存储库,因此在服务器中安装包含HTML doxygen的网页会很复杂(你实际上看不到带有git的项目文件--bare repo,所以我赢了除非我单独上传,否则无法看到doxygen生成的HTML文档

也许我可以做些什么cron-job,以保持服务器端的doxygen更新？

非常欢迎帮助.

我想在doxygen文档中包含文件夹.

我试过\ page和\ include但它没有用,有没有人知道怎么做？这是树:

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.php

我在一个相当大的C++库上尝试Graphviz和doxygen来生成UML.它生成.dot文件,但后来说它无法打开.map文件.

我正在通过Windows 7 64位上的msi运行doxygen 1.8.3和2.30.1.我还手动设置Graphviz bin文件夹的路径.

错误看起来像:错误:打开映射文件/inherit_graph_11.map以包含在文档中的问题!

当使用doxygen生成C++继承图时,我注意到图表可能不完整.

如果使用标记文件记录多个项目以允许交叉引用,则doxygen将成功显示其他标记文件中存在的所有基类,但如果它们位于其他标记文件中,则不会显示派生类.显示的派生类始终只是当前项目中存在的类.

示例项目1代码:

class A {};

class B : public A {};

class C : public A {};

示例项目2代码:

#include <proj1.h>

class D : public A {};

class E : public A {};

class F : public E {};

A项目1 的继承图,使用项目2中的标记文件 - 其中D,E&F？

E使用项目1中的标记文件 - 父类A显示项目2 的继承图.

是否有设置告诉doxygen在使用标记文件时跨项目生成完整的继承图？

我正处于C++项目的开始阶段,我从一开始就一直在使用Doxygen.

我想知道你在项目中如何使用Doxygen,即我有几个问题:

1.你在哪里提出你的Doxygen评论？标题或来源？

我认为他们应该去标题,因为这是我寻找如何使用方法的地方.但是,我想省略原型中的实际参数名称,所以我不能使用@param - 或者我可以吗？你是如何解决这个问题的？

你记录所有方法吗？

到目前为止我只记录公共方法,你是怎么做到的？您是否记录了访问者方法和公共变量？

你总是填写@param和@return吗？

在我工作的地方(它是Javadoc,但它是同一个问题),我们有一个约定只填充实际需要的属性,即如果简短描述说"返回xys if ......",我们省略@return.如果参数名称很明显,我们省略它们.我还不确定我是否喜欢这种方法,你是怎么做到的？到目前为止,我只填写了简介而没有其他内容,但并非所有方法原型都足够简单.

你用哪种风格？

Doxygen中有几种样式:Javadoc(/**... /),QT(/!...*/)等等.纯粹出于兴趣:你使用哪一个？我要使用Javadoc风格的ATM,因为我已经习惯了.

我在使用Doxygen和Visual Studio 2010和C++时遇到了困难.

除了"un/comment lines"之外,没有其他评论功能吗？例如,生成注释存根,并///在新行之后添加.

另外,我想知道在VS2010的IntelliSense功能中显示这些注释需要什么？

我正在使用doxygen来评论我的C代码.我正在使用外部API(即不是我自己的),文档很少,所以我打算在我自己的源文件中记录一些API.我确实有外部API的头文件,但将我自己的注释添加到该文件是不切实际的.

外国标题

struct foreignstruct
{
    int a;
    int b;
};

我的标题

/** My structure comments...
struct mystruct
{
    /** Describe field here... */
    int field;
};

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 *  @??? a Member 'a' contains...
 *  @??? b Member 'b' contains...
 */

我在的地方用什么标签@???,以获得正确的doxygen输出(其中"正确"的方法产生输出,mystruct并且foreignstruct是相同的)？

我对doxygen中的页面和组有疑问.我有一个项目,我用@defgroup和@ingroup cmds 对类进行分组.到目前为止这个工作正常.

现在,我想使用markdown页面向项目添加特殊文档.这些页面应出现在专用模块(组)中.我尝试使用@page和@subpage cmds 创建页面.这工作正常,但页面在菜单中显得清晰.

所以我试着用@ingroup将它们添加到组中.但这并不像我猜测的那样有用.是否可以将页面添加到模块(组)？

结果应如下所示:

项目
| - 模块
| | - "Module1"
| | | - documentation page1(来自*.md文件)
| | | - 类文档
| | - "Module2"
| | | - documentation page2
| | | - 类文档

我希望你能帮帮我!

我的叙述有代码片段,例如,::SomePlatformAPI()不是我的代码库的一部分,Doxygen警告说

warning: explicit link request to 'SomePlatformAPI()' could not be resolved

我试图添加\code并\endcode围绕它,但然后代码块启动一个新段落并打破当前的叙述.

有没有办法添加内联代码块？

更新:

事实证明这只是Doxygen 1.8及以上版本的问题.使用1.6,您没有此问题.