<返主目录 ▕▏C#基础库 WjwLibs: V5.0.1▕▏帮助文档 : C#源程序帮助文档创建 ▕▏ 编译日期: 2022-10-19▕▏ Email: wujwmail@163.com

〖C#源程序帮助文档创建〗 /wjw_cs.net/WjwLibs/wjw/WjwCSDoc.cs


类-1.名称: WjwCSDoc ▕→ 创建程序集帮助文档类

命名空间: WjwLibs
所属类: WjwLibs.WjwCSDoc
说明: 
    创建程序集帮助文档类
定义: 
    public class WjwCSDoc

方法名称: MakeAllHtml ▕→ 发布程序集Html帮助文档,主要方法,直接用这个即可

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     发布程序集Html帮助文档,主要方法,直接用这个即可
         可用此方法生成独立的内联样式表的Html帮助文档集
         相比vs的帮助文档生成器插件本方式更简单方便!
         如要自行定制,请用WjwCSDoc实例对象进行编程
             如要发布MD帮助文档请用MakeAll()方法
    用法:
      1. 在每个要生成帮助文档的源程序第一行加双斜线注释,这个注释将生成目录标题;不加或加-----将不解析该源文件
         例如: //这是一个示例, //-----这是一个不解析的示例,
      2. 可以在程序集目录下编辑一个readme.md文件,该文件将成为帮助主页的下半部的正文
             可用于对程序集的补充说明
      3. 要求:
         在C#源程序中对公有项加入C#的标准注释;非公有项将忽略不会解析,『summary』结点的第一行将解析为该项的主题,其它行将成为说明正文;
         如果不想输出本项目的文档可在『summary』结点的内容前加--
      4. 例如:
             (程序集)源目录: /wjw_cs.net/WjwLibs (windows下写为: d:\wjw_cs.net\WjwLibs)
             发布目录: /ngls/web_root/wjwlibs_cs (可直接输出到网站目录中)
             主题: C#基础库 WjwLibs
             NuGet项目库地址: https://www.nuget.org/packages/WjwLibs/ (没有可忽略)
         在你的程序中加入以下调用:
             WjwCSDoc.MakeAllHtml(@"/wjw_cs.net/WjwLibs",@"/ngls/web_root/wjwlibs_cs",@"C#基础库 WjwLibs",@"https://www.nuget.org/packages/WjwLibs/");
      5. 运行后在输出目录中就是程序集的Html格式的帮助文档,主页为index.html或[程序集名].html
 参数: 
     sPath : (程序集)源目录
     dPath : 发布目录
     title : 主题
     nuGetUrl : NuGet项目库地址(可忽略)
 定义: 
     public static void MakeAllHtml(string sPath, string dPath, string title, string nuGetUrl = null)

方法名称: MakeAll ▕→ 发布程序集MD帮助文档

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     发布程序集MD帮助文档
         MD文档对于安装有MD解析器的网站是一个更好的选择,本网站的网页由该方法产生
         用法参见MakeAllHtml
         运行后在输出目录中就是程序MD格式的帮助文档,用网站服务器的MD解析器输出即可,并在程序集目录中生成一个[函数表.txt]以供命令行来进行文本检索
         主页为[程序集名].md
             如要发布html帮助文档请用MakeAllHtml()方法
 参数: 
     sPath : (程序集)源目录
     dPath : 发布目录
     title : 主题
     nuGetUrl : NuGet项目库地址(可忽略)
 定义: 
     public static void MakeAll(string sPath, string dPath, string title, string nuGetUrl = null)

属性名称: CsFiles ▕→ 程序集源程序关联数组

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     程序集源程序关联数组
 定义: 
     public WjwKvs CsFiles;

属性名称: Path ▕→ 程序集根目录

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     程序集根目录
 定义: 
     public string Path = "";

属性名称: Title ▕→ 程序集文档主题

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     程序集文档主题
 定义: 
     public string Title = "";

属性名称: SubTitle ▕→ 当前项主题

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     当前项主题
 定义: 
     public string SubTitle = "";

方法名称: WjwCSDoc ▕→ 构造,要求源cs文件第一行用//注解[本文件的摘要]标记可解析

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     构造,要求源cs文件第一行用//注解[本文件的摘要]标记可解析
 参数: 
     path : 程序集根目录
     title : 程序集主题
 定义: 
     public WjwCSDoc(string path=null,string title="")

方法名称: GetFile ▕→ 获得程序集源程序文件数组

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     获得程序集源程序文件数组
 返回: 
     源程序文件数组
 定义: 
     public string[] GetFile()

方法名称: ToXStr ▕→ 解释一个C#源文件至XML串

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
      解释一个C#源文件至XML串
     注意: 回避xml的特殊字符
 参数: 
     fileCs : C#源文件
 返回: 
     XML串
 定义: 
     public string ToXStr(string fileCs)

方法名称: ToTxt ▕→ 解释一个C#源文件至MD文本

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     解释一个C#源文件至MD文本
 参数: 
     fileCs : C#源文件
 返回: 
     MD文本格式
 定义: 
     public string ToTxt(string fileCs)

方法名称: Md2Html ▕→ 解析MD字串至Html格式

 命名空间: WjwLibs
 所属类: WjwLibs.WjwCSDoc
 说明: 
     解析MD字串至Html格式
 参数: 
     mdTxt : MD字串
     title : 本网页的主题,null时忽略样式css_url参数返回html段落
     css_url : 本网页的样式表网址,null时为缺省内联样式返回完整的html文本
 返回: 
     Html格式字串
 定义: 
     public string Md2Html(string mdTxt,string title=null,string css_url=null)