C 的注释中的符号 (@) 是什么意思？

Question

我看到有些编程语言在注释中使用“@”。例如，这里是 Linux 内核中的一个随机程序： https://elixir.bootlin.com/linux/v5.10.11/source/fs/ext4/dir.c#L37

/**
 * is_dx_dir() - check if a directory is using htree indexing
 * @inode: directory inode
 *
 * ...
 */
static int is_dx_dir(struct inode *inode)
{

@在@inode中是什么意思？这种使用“@”符号的约定叫什么？它是否记录在 Internet 上的某处？

Answer 1

这只是文档工具的约定，与 C 无关。您可以在 Ruby 和 Java 中看到相同类型的注释，但我确定还有其他注释从同一来源汲取灵感。

如果这不仅仅是程序员的习惯，那就是自动生成文档并解释参数的目的。无论出于何种原因，@ 被选为“参数标识符”前缀。

Answer 2

似乎“@”符号确实是用于文档目的。在我给出的示例中，Linux 内核使用的是 Sphinx，约定记录在此处：

https://www.kernel.org/doc/html/v4.10/doc-guide/kernel-doc.html#writing-kernel-doc-comments

C 的注释中的符号 (@) 是什么意思？

What does at symbol (@) mean in comments for C?

c

comments