我有一个C ++（和一些CUDA）中的源存储库，我想对其进行充氧。我已经在某些（但不是全部）代码中添加了doxygen注释；生成了Doxygen配置文件，并运行doxygen以查看部分输出。
我得到的是：什么都没有。空的
生成一个主页，它只是什么都没有显示-即使我特别设置了EXTRACT_ALL = YES（在获得空结果后也是如此EXTRACT_ALL = NO。）
为什么什么都没有产生，我该如何解决？
笔记：
@file注释。doxygen.cfg（请参阅下文），问题仍然存在。doxygen.cfg （较短的版本，注释被过滤掉）：
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "cuda-api-wrappers"
PROJECT_BRIEF = "Thin C++-flavored wrappers for the CUDA Runtime API"
OUTPUT_DIRECTORY = docs
ALLOW_UNICODE_NAMES = YES
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
FULL_PATH_NAMES = YES
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
EXTENSION_MAPPING = …我目前正在开发Google Apps脚本库，该库基本上将电子表格视为数据库对象。
当前，该库具有两个相同的功能，例如
/**
* Opens and creates a query object for a spreadsheet with the given url.
*
* @param {String} the url of the spreadsheet
* @return {SpreadsheetQuery_} a spreadsheet query object for the given spreadsheet
*/
function openByUrl(url) {
return new SpreadsheetQuery_(SpreadsheetApp.openByUrl(url));
}
现在，对于这两个公共函数，生成的文档仅显示返回类型，而不显示参数或附带的说明。我假设这是一个Google问题，并没有真正打扰。
但是我的主要问题是，由于函数正在从私有函数实例化对象，因此如何获取自动文档以显示该对象上存在的方法。所有功能都将由对象提供，如果GAS可以在其上显示方法，那就太好了。
注意
这些方法都放在函数的原型上。例如。
SpreadsheetQuery_.prototype.from =函数（工作表）{
如果（_.isNumeric（sheet））{
....
}
谢谢。
documentation shared-libraries code-documentation intellisense-documentati google-apps-script
在Python解释器中:
有什么方法可以了解我的包装？
>>> man sys
File "<stdin>", line 1
man sys
^
SyntaxError:语法无效
>>> sys --help
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: bad operand type for unary -: '_Helper'
更正:
>>> help(sys)
...
现在,我如何在sys.path上看到我可以使用的所有软件包？并查看其后续使用和文档.我知道我可以轻松下载PDF,但所有这些东西已经出炉了,我不想复制文件.
谢谢!
假设我有这个：
internal abstract class Animal
{
internal bool IsExtinct { get; set; }
}
internal sealed class WoollyMammoth : Animal
{
internal int WeightLbs { get; set; }
/// <summary>
/// Construct a new instance with <see cref="IsExtinct"/> // this throws an error "XML comment has cref attribute 'IsExtinct' that could not be resolved".
/// set to "true" and <see cref="WeightLbs"/> // this works just fine.
/// initialized to 0.
/// </summary>
WoollyMammoth()
{
// no problem with either of …我想提供代码片段来展示如何在 python 中使用特定的方法或类。我怎样才能做到这一点？
在 Java 中可以<pre> ... </pre>这样做。
Doctest是唯一的方法吗？ 当我查看典型包（例如 pandas、numpy 等）的现有文档字符串时，除了 doctest 之外，我从未见过任何其他内容，它旨在测试该方法，而不仅仅是将文本格式化为 python 代码。那么，如果 doctest 是唯一的方法，那么将代码片段格式化为交互式 python 会话的正确方法是什么？我不想每次都在交互式会话中编写代码，然后将其 c+p 到我的文档字符串中。好像不太对劲。
出于某些原因,我想记录一个API,但我不想直接在源代码中编写文档,因为它现在已经广泛使用.我正在寻找一个文档生成器工具,它可以将文档文件作为输入,并且能够从源代码中获取函数原型并检查与文档的一致性.你知道任何可以做到这一点的工具吗？
我是一名正在学习编码的营销人员。目前我选择的主要武器是 Google Apps Scripts。当我深入研究并为其他人编写代码时，我想确保我的代码有很好的文档记录。在 GAS 之前，我从 Python 开始，其中 PEP-8 对此有明确的指导方针。GAS 有类似的指南吗？
我当前如何记录函数（除了具有清晰的变量名称和一些内联注释之外：
在每个脚本的顶部：
/**
* @name The name of the script
*
* @fileoverview The overview and expected outcome
*
* @author my name and e-mail address
*
* @version 1.0
*
* @changelog
* - version 1.0
* - Released initial version.
*/
每个函数定义如下：
function buildResultsObject(contactList) {
/**
* Parses the contactList to create
* an object per countryCategory ID
*
* The data array in the object is …我在我的实现中更改了一些东西，我想标记一些不推荐使用的类，以便他们将使用新的实现。
如何在 dart 中将类标记为已弃用？现在我只将它记录为已弃用，而没有实际标记类或将其划掉。
/// Throws a BadRequestException - 400
class BadRequestException implements Exception {}
/// Throws a NotFoundException - 404
class NotFoundException implements Exception {}
/// Throws a ConflictException - 409
class ConflictException implements Exception {}
/// [DEPRECATED]
/// Don't use this anymore, this is deprecated.
class AlreadyExistsException implements Exception {}
Doxygen 有没有办法报告源代码是否已记录？有什么方法可以识别一组 C++ 源文件中没有详细记录的文件集吗？
/// \brief Main function
/// \param argc An integer argument count of the command line arguments
/// \param argv An argument vector of the command line arguments
/// \return an integer 0 upon exit success
int main(int argc, char** argv)
{
/// Comments I would like to be documented in as well
return 0;
}
我使用的命令如下
$> doxygen Doxyfile && echo "success" || echo "failed"
我正在将我的项目升级到 PHP 8.0+。到目前为止，在代码注释中，我使用了@param和@return标签，如“选项 1”，而不是“选项 2”：
选项1：
@param string[] ...。@return User[] ...。选项2：
@param array ...。@return array ...。不过，因为我不知道第一种形式是否被官方允许，所以我开始问自己，切换到第二种形式是否会更好......所以，我想问你：有吗？有没有可用的 PHP 代码文档官方PHPDoc 参考资料？
另外，是否建议使用第一个选项而不是第二个选项？换句话说：是否有任何反对的论据——也考虑到未来？
感谢您的时间。
PS ：我找到了PHPDocumentor的参考资料，但我有一种感觉，它不是官方的 PHP 参考资料，而且还不兼容 PHP 8.0+。