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”有效吗？它在某处记录了吗？

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

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

在 C# 中，通常我可以在任何对象上放置 docblock 以获得关于该对象的 IDE 提示。它适用于我使用的大多数编辑器 JavaScript。它在 Python.

工作

C 是否存在类似的东西，如果存在 - 我在哪里可以找到它的文档？

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

“看起来没有太多适合您搜索的匹配项”

更奇怪的是，我经常在很久以后才找到我要找的东西，并且看到它与我的查询相匹配，但是由于某些奇怪的原因 Google 找不到它。假设我的页面包含单词“等离子电容器”。这是关于等离子电容器。但它在某种程度上与 C 相关。假设它是一个 C 库。我在 Google 中输入“plasma capacitor”，得到了令人气愤的信息。然后我在寻找完全不同但有点相关的东西，然后我点击那里的 link，然后 BLAM：“等离子电容器”- 它在那里，但只是没有从搜索中返回。

Answer 1

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

然而，大多数现代 IDE 可以显示有关从评论中收集的符号的信息，即使评论不遵循特定格式也是如此。

C有一种docblock语法吗？它在 STM32CubeIDE 中工作吗？

Is there a kind of docblock syntax for C? Does it work in STM32CubeIDE?

c

stm32cubeide