简单只要一行代码
Nuget库下载地址: https://www.nuget.org/packages/WjwLibs/
示例: http://www.wujwmail.cn/wjwlibs_cs/WjwLibs.md
命名空间: WjwLibs
所属类: WjwLibs.WjwCSDoc
说明:
发布程序集帮助文档,主要方法,直接用这个即可
-----除非要自行定制否则不要用WjwCSDoc实例对象(vs的帮助文档生成器插件用起来很麻烦!)
用法:
1. 在每个要生成帮助文档的源程序第一行加双斜线注释,这个注释将生成目录标题;不加或加-----将不解析该源文件
例如: //这是一个示例, //-----这是一个不解析的示例,
2. 要求:
在C#源程序中对公有项加入C#的标准注释;非公有项将忽略不会解析,『summary』结点的第一行将解析为该项的主题,其它行将成为说明正文
3. 在你的程序中加入以下调用,例如:
WjwCSDoc.MakeAll(@"/wjw_cs.net/WjwLibs",@"/ngls/web_root/wjwlibs_cs",@"C#基础库 WjwLibs",@"https://www.nuget.org/packages/WjwLibs/");
4. 运行后在输出目录中就是程序MD格式的帮助文档,用网站服务器的MD解析器输出即可,并在程序集目录中生成一个[函数表.txt]以供命令行来进行文本检索
参数:
sPath : (程序集)源目录
dPath : 发布目录
title : 主题
nuGetUrl : NuGet项目库地址
定义:
public static void MakeAll(string sPath, string dPath, string title, string nuGetUrl = null)