gpt4 book ai didi

doxygen - Doxygen 是否具有续行功能?

转载 作者:行者123 更新时间:2023-12-02 06:26:54 29 4
gpt4 key购买 nike

我想将源文件中的行长度限制为 80 个字符。当将 Doxygen 函数链接到具有长原型(prototype)的函数时,这是一个问题,例如因为参数的类型名称很长。

在生成文档时,Doxygen 是否可以忽略注释中的换行符(即续行)?

这是一个 MWE:

我有以下名为mwe.cpp

的文件
/**
* \file mwe.cpp
*
* \details
* MWE::MWE(int a, int b, int c)
* MWE::MWE(int a,
* int b, int c)
*/


class MWE
{
public:
/**
* \brief constructor with one parameter
*/
MWE(int a);

/**
* \brief constructor with three parameters
**/
MWE(int a, int b, int c);
}

生成文档时,第一个链接 (MWE::func(int a, int b, int c)) 正确指向采用三个整数参数的构造函数。然而,第二个链接有一个换行符,指向仅采用单个整数参数的构造函数(参数列表也不会成为链接的一部分,只有函数名称)。

有没有办法让 Doxygen 忽略换行符?

最佳答案

感谢阿尔伯特的comment ,我开始搜索 Doxygen 错误报告并发现 this相关错误报告。该错误报告现已迁移至 Github here .

显然,诀窍是将换行符放在 HTML 注释中。

MWE 生成的代码是:

/**
* \file mwe.cpp
*
* \details
* MWE::MWE(int a, int b, int c)
* MWE::MWE(int a, <!--
* --> int b, int c)
*/


class MWE
{
public:
/**
* \brief constructor with one parameter
*/
MWE(int a);

/**
* \brief constructor with three parameters
**/
MWE(int a, int b, int c);
}

不完全是续行功能,但它解决了问题。现在,两个链接是相同的,并且正确指向采用三个整数参数的构造函数。

关于doxygen - Doxygen 是否具有续行功能?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/46744573/

29 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com