首页 > 代码库 > C++/CLI 托管C++之导出注释【11】

C++/CLI 托管C++之导出注释【11】

将封装好的CLI Dll提供给NET使用时,当然少不了注释的添加。本文就是介绍使用XML注释的方式,获取Dll对应的注释。涉及两点:


【1】CLI的成员的注释需要按照标准的方式进行添加,简单点就是C#怎样添加注释///, CLI也要按照同样的方式添加,如下图:

/// <summary>
/// 1 字符串测试类
/// </summary>
public ref class StrCls
{
public:
    /// <summary>
    /// 1.1 字符串作为输入参数
    /// </summary>
    /// <param name="pInStr">字符串</param>  
    /// <returns>成功返回0</returns> 
    static Int32 StrOutput(String^ pInStr);       
    /// <summary>
    /// 1.2 字符串作为参数,需要进行修改返回
    /// </summary>
    /// <param name="pOutStr">字符串</param>  
    /// <returns>成功返回0</returns> 
    static Int32 StrChange(String^ %pOutStr);        
    /// <summary>
    /// 1.3 字符串数组作为参数
    /// </summary>
    /// <param name="ppStr">字符串数组</param>  
    /// <returns>成功返回0</returns> 
    static Int32 StrChangeArr(array<String^>^ %ppStr);
};

【2】需要在项目的配置中,选择配置生成XML文件(项目--属性)

技术分享


【3】重新编译项目,即可看到在Dll的同目录下,生成了相应的XMl注释,使用时XML与Dll需要在同目录下。

技术分享


C++/CLI 托管C++之导出注释【11】