C#怎么动态生成方法和Summary注释

C#怎么动态生成方法和Summary注释,第1张

C#中新建的类库添加注释时,应注意以下问题:

1、编译动态类库时命名空间要规范,一般不要和类同名,命名空间一般定义格式:项目名+类文件名;

2、动态类库中,类、方法的注释都采用下列方式注释:

类注释的格式:

/// <summary>

/// 文件名:Ini处理类/

/// 文件功能描述:读写Ini文件/

/// 版权所有:Copyright (C) ZGM/

/// 创建标识:2011.12.13/

/// 修改标识:/

/// 修改描述:/

/// </summary>

方法注释的格式:

/// <summary>

/// 读出Ini文件

/// </summary>

/// <param name="Section">Ini文件中的段落名称</param>

/// <param name="Key">Ini文件中的关键字</param>

/// <param name="IniFilePath">Ini文件的完整路径和名称</param>

/// <returns>Ini文件中关键字的数值</returns>

3、生成与动态类库相同名称的xml文件,具体设置是:项目右键—>属性—>生成—>XML文档文件选中再编译

4、引用动态类库时,把类库和同名的xml文件放到同一个文件夹内即可。

插件地址: gitbook-plugin-summary

插件说明:

summary: 自动生成SUMMARY.md文件

toggle-chapters: 菜单可以折叠

theme-comscore: 主题插件, 修改标题和表格颜色

在根目录下新增目录, 如取名 "菜单1", 在菜单1目录中新增0-README.md文件, 并在该文件中加入标题

该标题对应gitbook中该菜单名称.

子菜单添加规则一致, 需要在目录中加入README.md文件, 并指定文件中的标题为菜单名称

在菜单中加入 用户指南 MARKDOWN文件, 并修改该文件的标题为


欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/bake/11408699.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2023-05-15
下一篇2023-05-15

发表评论

登录后才能评论

评论列表(0条)

    保存