C 有没有一种 docblock 语法？ 它在 STM32CubeIDE 中有效吗？

Question

假设我有一个函数声明：

int32_t get_adc_reading();

我想在不访问头文件的情况下获得任何帮助，所以......

/**
 * Gets a reading from ADC.
 * @retval 12-bit reading value.
 */
int32_t get_adc_reading();

IDE 似乎忽略了注释。 它甚至有效吗？ “@retval”有效吗？ 它在某处记录了吗？

我尝试谷歌它，但我什么也没得到。

可能我不知道怎么问。 我以前主要用 C# 编码，我现在正在学习 C。

在 C# 中，我可以在任何对象上放置一个docblock来获取有关该对象的 IDE 提示，这很正常。 它在我使用的大多数编辑器中都适用于 JavaScript。 它在 Python 中工作。

C 是否甚至存在这样的东西，如果是这样 - 我在哪里可以找到它的文档？

我在学习 C 和使用 Google 时遇到的另一件奇怪的事情：

“您搜索的匹配项似乎并不多”

更奇怪的是，我经常在很久以后才找到我要查找的内容并发现它与我的查询相匹配，但是由于某种奇怪的原因 Google 没有找到它。 假设我的页面包含“等离子电容器”字样。 这是关于等离子电容器。 但它在某种程度上与 C 相关。假设它是一个 C 库。 我在 Google 中输入“等离子电容器”并收到令人愤怒的消息。 然后我正在寻找完全不同但有点相关的东西，然后我点击那里的链接，然后 BLAM：“等离子电容器” - 它在那里，但它没有从搜索中返回。

Answer 1

与 C# 不同，C++ 没有标准的注释文档格式。 最常用的一种是Doxygen 。

然而，大多数现代 IDE 可以显示有关从注释收集的符​​号的信息，即使注释不遵循特定格式。