Linux内核文档：如何写符合 kernel-doc 规范的注释-阿里云开发者社区

Linux内核文档：如何写符合 kernel-doc 规范的注释
简介#
Linux内核使用 Sphinx 实现把 Documentation 目录下的 reStructuredText 文件转换为非常漂亮的文档。文档既可以通过 make htmldocs转换成 HTML 格式，也可以通过 make pdfdocs 转换为 PDF 格式。转换生成的文档存放于 Documentation/output 目录下。

Linux内核强大的文档功能，除了直接转换 .rst文档之外，还能从源码中汲取API说明，结构体说明等信息。当然要做到这样，源码的注释是有一定要求的。而这篇文档，就是介绍如何写符合 kernel-doc 格式要求的注释。

英文版原文，根据个人理解做的翻译，如果有翻译错误的地方，请告知。

注释概述#
符合 kernel-doc 的注释，都需要从 /* 开始，其后每一行内容都以开头，最后是 */ 表示结束。例如：

Copy
/**

This is a sample of comment
*/

对于函数和类型的注释，必须放在函数和类型之前，以便于别人在修改代码的时候，可以顺手把注释也改了。对概述类型的注释，可以放到文件顶部的位置。

Linux内核有提供一个工具用于对 kernel-doc 的格式进行检查，例如：

Copy
$ scripts/kernel-doc -v -none drivers/foo/bar.c
当然，在编译的时候，如果添加以下的选项，也会检查文档的格式：

Copy
make W=n
函数文档#
规范的格式示例如下：

Copy
/**

function_name() - Brief description of function.
@arg1: Describe the first argument.
@arg2: Describe the second argument.
One can provide multiple line descriptions
for arguments.
*
A longer description, with more discussion of the function function_name()
that might be useful to those using or modifying it. Begins with an
empty comment line, and may include additional embedded empty
comment lines.
*
The longer description may have multiple paragraphs.
*
Context: Describes whether the function can sleep, what locks it takes,
releases, or expects to be held. It can extend over multiple
lines.
Return: Describe the return value of function_name.
*
The return value description can also have multiple paragraphs, and should
be placed at the end of the comment block.
*/

函数名后的函数功能简介可以跨越多行，以函数参数描述、返回值描述或其他描述结束。

函数参数#
函数参数的描述，必须直接且按顺序放在函数简介之后。需要注意的是，函数参数与函数简介、函数参数与函数参数之间不能有任何空行。

每个函数参数的描述可以跨行，但要注意的是，必须保持缩进对齐，例如

Copy

@argument: some long description
that continues on next lines # that 必须与 some对齐（避免排版乱套，补充说明）
或者

Copy

@argument:
some long description
that continues on next lines
函数参数#

如果出现不定数量个参数，可以这么表示：

Copy

@...: description
函数上下文#

描述这个函数会在什么场景下调用，就是函数上下文字段所要做的。函数上下文字段用Context:表示，应该包含函数是否会休眠，是否会在中断中调用，以及它会持有、释放什么锁，和其他所有调用这个函数需要注意的东西。

例如：

Copy

Context: Any context.
Context: Any context. Takes and releases the RCU lock.
Context: Any context. Expects to be held by caller.
Context: Process context. May sleep if @gfp flags permit.
Context: Process context. Takes and releases .
Context: Softirq or process context. Takes and releases , BH-safe.
Context: Interrupt context.
函数返回值#

函数返回值相关的描述应该放在Return:字段。

由于不能识别换行，因此如果你这样写：

Copy

Return:
0 - OK
-EINVAL - invalid argument
-ENOMEM - out of memory
效果只会是：

Copy
Return: 0 - OK -EINVAL - invalid argument -ENOMEM - out of memory
所以呢，如果你要换行，你需要使用 ReST List，例如：

Copy

Return:
- 0 - OK to runtime suspend the device
- -EBUSY - Device should not be runtime suspended
  另外，如果字段出现类似key:这样短语加冒号的形式，会被识别为其他的字段。这点需要注意。

struct 和 union 和 enum 类型的注释#
通常 struct ，union 和 enum 类型的注释说明是这样的：

Copy
/**

struct struct_name - Brief description.
@member1: Description of member1.
@member2: Description of member2.
One can provide multiple line descriptions
for members.
*
Description of the structure.
*/

紧随名字后面的 Brief description 可以跨度几行，它以 @member 字段、空行或者*/表示结束。

成员#
struct，union 和 enum 的成员注释格式与函数参数的格式一致，他们都需要简短的描述且支持换行。

在 struct 和 union 里面也支持注释。支持 private 和 public 两种标签。private 标签的成员不会呈现到编译出来的文档上，类似与 C++ 上的 private 成员。

需要注意的是，private 和 public 标签必须以*标识开始且不能有缩进，以/标识结束。如果有简介，可以写在:与结束标识/之间，例如：

Copy
/**

struct my_struct - short description
@a: first member
@b: second member
@d: fourth member
*
Longer description
*/

struct my_struct {

int a;
int b;

/ private: internal use only /

int c;

/ public: the next one is public /

int d;

};
嵌套struct和union#
如果出现嵌套定义 struct和union，可以参考下面的做法：

Copy
/**

struct nested_foobar - a struct with nested unions and structs
@memb1: first member of anonymous union/anonymous struct
@memb2: second member of anonymous union/anonymous struct
@memb3: third member of anonymous union/anonymous struct
@memb4: fourth member of anonymous union/anonymous struct
@bar: non-anonymous union
@bar.st1: struct st1 inside @bar
@bar.st2: struct st2 inside @bar
@bar.st1.memb1: first member of struct st1 on union bar
@bar.st1.memb2: second member of struct st1 on union bar
@bar.st2.memb1: first member of struct st2 on union bar
@bar.st2.memb2: second member of struct st2 on union bar
*/

struct nested_foobar {
/ Anonymous union/struct/
union {

struct {
  int memb1;
  int memb2;
}
struct {
  void *memb3;
  int memb4;
}

}
union {

struct {
  int memb1;
  int memb2;
} st1;
struct {
  void *memb1;
  int memb2;
} st2;

} bar;
};
有两点要注意的：

如果嵌套的struct或者union有命名，那么应该使用@foo.bar的形式，例如上例的@bar.st1
如果是匿名的，那么需要直接使用@bar的形式，例如上例的@memb1
细心的小伙伴可能发现，这与C语言上结构体的调用方式非常相似。

内联的成员描述#
成员的描述除了放在开头，还可以放在 struct 和 union 里面。支持单行或者多行，以/*开头，以/结束。例如：

Copy
/*

struct foo - Brief description.
@foo: The Foo member.
*/

struct foo {

  int foo;
  /**
   * @bar: The Bar member.
   */
  int bar;
  /**
   * @baz: The Baz member.
   *
   * Here, the member description may contain several paragraphs.
   */
  int baz;
  union {
          /** @foobar: Single line description. */
          int foobar;
  };
  /** @bar2: Description for struct @bar2 inside @foo */
  struct {
          /**
           * @bar2.barbar: Description for @barbar inside @foo.bar2
           */
          int barbar;
  } bar2;

};
typedef注释#
通常格式如下：

Copy
/**