[英]What does at symbol (@) mean in comments for C?
我看到一些编程语言在注释中使用“@”。 比如这里是Linux kernel中的一个随机程序: 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
中的@
是什么意思? 这种使用“@”符号的约定叫什么? 它是否记录在 Inte.net 的某处?
这只是文档工具的约定,与 C 无关。您可以在 Ruby 和 Java 中看到相同类型的评论,但我敢肯定还有其他人从同一来源获得灵感。
如果这不仅仅是程序员的习惯,它会自动发出文档并解释 arguments 的用途。无论出于何种原因, @
被选为“参数标识符”前缀。
似乎“@”符号确实是用于文档目的。 在我给出的示例中,Linux kernel 使用的是 Sphinx,约定记录在此处:
https://www.kernel.org/doc/html/v4.10/doc-guide/kernel-doc.html#writing-kernel-doc-comments
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.