C++/CLR代码注释规范

1、C++/CLR的代码注释规范需要与C#中的xml注释规范保持一致；
2、C#查看C++/CLR的代码注释，需要保证C++/CLR的工程输出了代码注释的XML文件，且在C#的工程的运行路径中添加了该XML文件。

C#中的XML注释规范：
所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是XML注释，需要适当地处理。

当开发人员输入三个向前的斜线后，Microsoft Visual Studio .NET IDE 自动检查它是否在类或者类成员的定义的前面。如果是的话，Visual Studio .NET IDE 将自动插入注释标记，开发人员只需要增加些额外的标记和值。
例如：类成员变量
/// <summary>
/// 当前选中的资源对应的IFeatureClass对象
/// </summary>
private IFeatureClass m_CurrentFeaturerClass = null;

例如：类函数
/// <summary>
  /// 获取当前选择缓冲半径的字段值
  /// </summary>
  /// <param name="strFieldName"></param>
  /// <returns>返回值为-1 表示当前不是属性缓冲，反之则表示属性缓冲的字段索引</returns>
  private int GetBufferFieldIndex(string strFieldName)
  {
      int nindex = -1;
      if (string.IsNullOrEmpty(strFieldName))
          return nindex;
      m_CurrentFields.FindField(strFieldName, out nindex);
      return nindex;
  }
  
例如：类
/// <summary>
/// 缓冲区分析
/// </summary>
public class BufferViewModel : ViewModelBase
{
}

C++/CLR的工程输出XML注释：
需要在项目的配置中，选择配置生成XML文件（项目–属性-C/C+±输出文件：设置【生成xml文档文件】为YES）
这里写图片描述

C++/CLR工程中添加XML注释的方法：
目前暂未找到快速或批量生成XML注释的方法，需要手动按照XML注释标准输入。

C#调用C++/CLR工程时，怎么查看C++/CLR中的代码：
1）鼠标移动到CLI中方法处，自动弹出函数定义和注释
这里写图片描述
2)F12定位到函数定义处

C++/CLR代码注释规范

猜你喜欢