腾讯云
开发者社区
文档
建议反馈
控制台
登录/注册
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
搜索
搜索
关闭
发布
文章
问答
(9999+)
视频
沙龙
1
回答
函数文档和内部类文档之间
的
混淆
、
、
、
DO2 1.8.10/*! This is a test class class TestClass { */ 当我为上述类生成
doxygen
没有
创建
名为classInnerTestClass.html
的
内部类文档
文件
。在
浏览 2
提问于2015-09-10
得票数 0
回答已采纳
5
回答
将
Doxygen
与C一起使用时,您是注释函数原型还是注释定义?还是两者都有?
、
、
、
我正在使用
Doxygen
和一些内嵌
的
C源代码。给定一个.c/.h
文件
对,您是在函数原型(.h
文件
)上还是在函数定义(.c
文件
)上放置
Doxygen
注释,还是在这两个位置都复制它们?我遇到了一个问题,当我在一个地方而不是另一个地方
记录
文档时,
Doxygen
会警告我遗漏了注释;这是意料之中
的
吗,还是我
的
Doxygen
搞砸了?
浏览 9
提问于2009-08-13
得票数 26
1
回答
从CMake脚本构建
doxygen
、
我在网上找到了一个示例cmake
文件
,并将其放在我
的
项目的DOOX子目录
中
,myproject.doxgen
文件
也位于这个子目录
中
,其中包含/doc配置。我已经测试过,运行
doxygen
.exe myproject.
doxygen
会产生有效
的
输出。我只需要将它构建到CMake过程
中
。based
API
documentation (requires
Doxygen
)&quo
浏览 0
提问于2016-01-19
得票数 17
回答已采纳
5
回答
C++:在哪里编写代码文档:.cpp还是.hpp
文件
?
、
、
习惯上在哪里编写类和方法
的
代码内文档?对于这样
的
事情,有没有一个广受推崇
的
惯例?大多数C++项目是以一种方式而不是另一种方式来完成
的
吗? 或者文档应该写在两面(即在.hpp和.cpp
文件
中
),可能一边是简短
的
描述,另一面是较长
的
描述?最重要<em
浏览 0
提问于2010-08-26
得票数 35
回答已采纳
2
回答
使用
Doxygen
从相同
的
代码库生成“用户”和“开发人员”文档
、
我是
Doxygen
的
新手,我正在尝试
记录
一个我计划开源
的
API
。我真的很想构建两套文档,一套适用于
API
的
最终用户,另一套适用于打算修改它
的
用户。有没有一种方法可以标记
Doxygen
注释块,这样我就可以生成"user“和"dev”文档树?我
的
问题有没有更好
的
解决方案?谢谢!
浏览 4
提问于2011-08-04
得票数 3
回答已采纳
2
回答
如何
使用
Doxygen
记录
应用程序源
文件
、
程序
的
树形结构如下: |---- lib1 |----include |----src |---- app1 |---- app2App1和app2是使用lib1和lib2
的
两个应用程序我已经在lib1和lib2
中
记录
了头
文件
。然而,我也想
记录
app1和app2,因为
浏览 0
提问于2017-09-19
得票数 0
1
回答
文档未出现在
doxygen
输出
中
我正在尝试
记录
一个C
API
,它包含在一个单独
的
C头
文件
中
。当我在
文件
上运行
doxygen
时,它给出了当前没有文档
记录
的
C宏
的
错误,但是当我为宏添加必要
的
文档时,尽管没有文档
记录
的
错误被清除,宏和文档不会出现在
doxygen
生成
的
html输出
中
。只有一小部分文档头
文件
,即结构,实际上出现在任何
浏览 3
提问于2013-09-07
得票数 6
2
回答
文档化一个库--是所有的东西,还是只
记录
公共
头中
的
函数?
、
如果您正在开发和文档库..您是
记录
每个源
文件
中
的
每个函数/数据结构,还是只
记录
出现在
公共
头
文件
中
的
公共
函数/数据结构?? 我倾向于第二种选择,这样可以吗?
浏览 0
提问于2011-09-15
得票数 0
回答已采纳
3
回答
如何
从javadoc中排除某些类/包/
公共
成员
、
、
、
我从C#
创建
了java
api
-ported,更具体地说,它除了
公共
接口之外,还包含了许多我不想让用户知道
的
内部内容。在C#
中
,我使用了
doxygen
来生成文档。我假设javadoc具有类似的功能,可以排除某些
公共
成员、类,甚至包。谢谢
浏览 1
提问于2009-02-26
得票数 1
回答已采纳
2
回答
使用
Doxygen
分别提取类
的
公共
方法列表
、
、
、
我正在为我
的
C++项目使用
Doxygen
,该项目将托管在github
中
。到目前为止,我还没有找到一种生成markdown
文件
的
方法。我<
浏览 0
提问于2012-10-26
得票数 4
1
回答
Doxygen
没有在PHP
中
记录
我
的
非类函数?
、
、
我正在使用
Doxygen
(Doxywizard,GUI)来
记录
一个PHP项目。
Doxygen
没有
记录
我
的
非类
文件
。这就是为我生成
的
goes向导
浏览 0
提问于2011-08-28
得票数 4
回答已采纳
2
回答
Doxygen
:复制单个参数
的
描述
、
在我
的
源代码
中
,我经常得到具有相同参数
的
函数。因此,此参数
的
说明也是相同
的
。我知道我可以使用\copybrief、\copydoc或\copydetails复制文档,但它们是否也可以复制单个参数
的
描述?或者,有没有办法只在代码
中
的
某个地方管理这个参数
的
描述?感谢你对m0nKeY
的
帮助
浏览 1
提问于2015-09-23
得票数 4
3
回答
在
doxygen
中
记录
#undef
的
好方法
、
我目前在c
文件
中有几个#define,它们为硬件测试关闭了一些功能。但是,当它们还未定义时,我想用
doxygen
来
记录
它们。#define SIMULATE_SOME_HW_INTERFACE
如何
强制
dox
浏览 2
提问于2010-08-25
得票数 3
回答已采纳
2
回答
如何
避免c++和boost::python之间
的
冗余?
、
、
、
我正在使用boost::python在c++代码
中
添加一个python模块。c++项目是用
doxygen
记录
的
。我想为python模块
创建
一个文档,但我不知道
如何
避免这样
的
冗余:using namespace boost::python; /** @briefn\n:param a: an integer\n:param b: another integer\n:returns:
浏览 5
提问于2016-01-20
得票数 4
回答已采纳
1
回答
.Net程序集
的
文档报告
、
、
、
我正在使用沙堡为我
的
API
生成文档,但是在我为其生成chm
的
程序集中有许多未
记录
的
源代码,有没有办法获得未
记录
类型
的
列表(或那些缺少成员文档
的
类型)?
浏览 1
提问于2011-08-07
得票数 1
回答已采纳
2
回答
来自PHP代码
的
自动文档
、
、
好
的
,我知道有PhpDocumentor可以从php代码中生成文档。它似乎已经很长时间没有更新了(但也许他们认为它
的
大部分功能都是完整
的
)。虽然这对于
记录
其他程序员
的
事情可能很好,但它似乎不太适合
记录
web服务
的
外部"
API
“。也就是说,如果我有一个很好
的
MVC结构化项目,PhpDocumentor可能非常适合为项目中
的
其他开发人员
记录
所有的模型和内部库等,但是我
如何
<e
浏览 1
提问于2010-01-22
得票数 2
3
回答
我可以使用
DoxyGen
来
记录
ActionScript代码吗?
、
、
、
如何
配置
DoxyGen
以
记录
ActionScript
文件
? 我已经在
doxygen
的
搜索模式
中
包含了*.as和*.asi
文件
,但其中没有显示类、函数和变量。
浏览 0
提问于2008-09-24
得票数 11
回答已采纳
1
回答
Doxygen
:不包括无
文件
文件
我有一个我正在扩展
的
框架。有一些源
文件
夹包含了相当多
的
文件
,我想使用
doxygen
来
记录
我
的
工作(特别是那些来自我
的
文件
)。我
记录
的
任何
文件
都是头
文件
: * @file my_file.c我能告诉
doxygen
不要包含没有这样一个头
的
文件</e
浏览 5
提问于2014-06-02
得票数 1
回答已采纳
5
回答
C/C++头
文件
文档
、
、
、
您认为在C++
中
创建
公共
头
文件
时
的
最佳实践是什么? 头
文件
应该不包含文档、简短文档还是大量文档?我见过从几乎没有文档(依赖于一些外部文档)到大规格
的
不变量、有效参数、返回值等等。我不确定我到底喜欢什么,大
的
文档很好,因为你总是可以从你
的
编辑器
中
访问它,另一方面,一个包含非常简短
的
文档
的
头
文件
通常可以在一到两页
的
文本
中
显示完整<e
浏览 75
提问于2009-01-28
得票数 19
回答已采纳
点击加载更多
热门
标签
更多标签
云服务器
ICP备案
云直播
腾讯会议
实时音视频
活动推荐
运营活动
广告
关闭
领券