在C语言的注释中,符号“@”代表什么意思?

4

我发现有些编程语言在注释中使用“@”符号。例如,在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中表示什么?使用“@”符号的约定叫做什么?是否有关于这个约定的文档可以参考?


3
可以用于文档工具的目的。 - IrAM
4
请注意,这并没有被编程语言所规定。它通常是代码编写者使用的非正式约定,或者是一种文档命令(例如,doxygen 使用 @ 作为命令)。 - kaylum
2个回答

3

这只是文档工具的惯例,与C语言无关。你也可以在Ruby和Java中看到相同类型的注释,尽管我相信还有其他语言从同一来源获得灵感。

如果这不仅仅是程序员的习惯,那么它就是为了自动发出文档并解释参数的目的而选择使用@作为“参数标识符”前缀的原因。


2

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接