如何:对 C 代码进行批注

更新:2007 年 11 月

若要在 C 中批注代码,应包括 SourceAnnotations.h 文件,然后使用属性来批注函数参数或返回值。

在 C 中批注代码

  1. 向项目头文件添加 #include <CodeAnalysis/SourceAnnotations.h> 文件。

  2. 下一步,使用属性来批注代码。

示例

下面的代码演示如何批注 C 代码:

// MyCode.h
#include <CodeAnalysis/SourceAnnotations.h>

// MyCode.c
#include "MyCode.h"
void f ( [SA_Pre (Valid = SA_Yes)] int pWidth )
{
  // code...
}

在 C++ 中,SA_ 前缀是可选的。

请参见

概念

批注概述

其他资源

批注属性