WebAPI代码注释生成XML

一，右键项目属性–生成–勾选XML文档文件–将文档文件路径设置为App_Data\MES_Server.XML

二，设置XML的属性

Visual Studio文件属性主要用到的为：复制到输出目录和生成操作。

复制到输出目录根据选项就可以明白是标示该文件是否输出到生成的目录地址；

生成操作则主要指该文件在执行生成时对文件执行的何种操作，常用的有以下几种：

无： 不在项目输出组中包含该文件，并且在生成进程中不会对其进行编译，发布之后不会输出到生成目录。

编译： 将该文件编译到输出目录中。此设置一般用于代码文件，代码文件默认为编译。

内容： 不编译该文件，但将其包含在输出组中。 不编译，但是发布之后会原样输出，如：图片文件等，一般默认为无，需要更改为内容。

嵌入的资源：将该文件作为 DLL 或可执行文件嵌入主项目生成输出中。此设置通常用于资源文件。例如NHibernate的映射文件。

Embedded Resource(嵌入的资源)
.NET中使用外部资源时常用的方式都是使用资源文件，作为程序集的一部分发布。资源文件的读取也比较方便，字符串、图片和任何二进制数据，包括任何类型的文件都可以作为资源的项。

使用资源文件时VS也会自动生成相应的方法来获取资源，用xml编辑器打开后缀.resx的文件，可以看到资源文件是用xml方式存储的。

Embedded Resource亦即嵌入式资源文件，和资源一样，通过一些设置后也可以作为程序集的一部分发布。有时候我们不想用资源文件的时候也可以使用嵌入式资源，例如将文件my.xml作为资源文件嵌入的设置方法：

通过reflector打开程序集可以看到，my.xml文件已经作为程序集的一部分：

其嵌入的资源文件命名规则为：程序集+文件夹名（如果存在）+文件名（含后缀名）。

文件属性中“Copy to OutPut Directory”选定嵌入资源文件的的输出方式。

关于资源文件/嵌入式资源文件的读取

读取资源文件/嵌入式资源文件的一般方式为先加载资源所在的程序集，利用反射获取程序集中的外部文件数据：

读取资源文件名使用: string[] Assembly.GetManifestResourceNames(). 返回的是所有程序集资源清单文件

资源文件的读取使用: System.Resources.ResourceManager类，构造函数签名：public ResourceManager(string baseName, Assembly assembly).

嵌入式资源文件的读取使用: Assembly.GetManifestResourceStream(string name)

下面是一段参考代码：

static void Main(string[] args)
       {
           Assembly assembly = Assembly.Load("ResourceSample");
           string content = string.Empty;
 
           //GetManifestResourceNames:this method used to find all resource name.
           foreach (string resource in assembly.GetManifestResourceNames())
           {
               Console.WriteLine("Manifest:{0}", resource);
               if (resource.IndexOf(".Resource1") > 0)
               {
                   ResourceManager manager = new ResourceManager("ResourceSample.Resource1", assembly);
                   //read specified string 
                   Console.WriteLine("resource key:mytest,value:{0}",manager.GetString("mytest"));
               }
               else
               {
                   //read Embedded  resource
                   using (Stream stream = assembly.GetManifestResourceStream(resource))
                   {
                       using (StreamReader reader = new StreamReader(stream))
                       {
                           Console.WriteLine(reader.ReadToEnd());
                       }
                   }
               }
           }
            
           Console.ReadKey();
       }