zoukankan      html  css  js  c++  java
  • 【新阁教育上位机】为什么我的VS自带的类怎么都没有注释了?

    1、为什么我的VS自带的类怎么都没有注释了?

          这是很多同学经常遇到的一个问题,通常我会让他们自己切换一下其他的.Net Framework试试,通过都能解决问题,但是究其原因,今天跟大家彻底剖析一下。

          首先我们要明确一下,dll的注释是如何来的,dll天生就是不带注释的,如果你看到的dll有注释,不管是中文还是英文,其实是通过与该dll配套的一个xml文件产生的。

          这样就很容易理解,为什么切换一下.Net Framework就能让VS自带的类变得有注释了。因为不同.Net Framework的dll在VS安装目录里是对应不同的文件夹的,具体可以从下图看到:

    路径如下:C:Program Files (x86)Reference AssembliesMicrosoftFramework.NETFramework

    你打开没有注释对应的文件夹与有注释对应的文件夹,你会发现有注释的dll文件夹里会多一个名字叫做zh-Hans的文件夹,所以如果你能把这个文件夹复制过去,其他的.Net Framework也会有中文注释。

     

    2、怎么让我的dll带有注释?

          如果上一个问题可以弄清楚,那么这个问题就变得简单了,说白了就是需要提供一个xml文件,但是这个xml文件难道是直接写的吗?

           其实并不是,在你的dll对应的类库,右击属性中,我们在生成页面中,可以看到一个XML文档文件的选项,勾选一下。

     这样你再次生成的时候,根目录下就会自动多一个同名xml文件,这就是我们需要的xml文件。

    但是这个xml文件里面是没有什么内容的,你复制过去也没用,需要你给所有的公共方法属性,通过///的方式添加注释,才会有意义。至于哪些地方需要加注释,你勾选之后,编译一下,自动会告诉你哪些地方需要加注释。

        /// <summary>

        /// 

        /// </summary>

    注意事项:

    最后一个需要注意的地方,如果xml文件复制进去了,仍然看不到注释,需要重启一下VS或者删除引用重新添加一下。

  • 相关阅读:
    FFT-C语言
    C语言解析WAV音频文件
    图基(Tukey)检验
    方差分析中均值比较的方法
    模拟信号采样过程
    FS,FT,DFS,DTFT,DFT,FFT的联系和区别
    枚举enum类型
    样本概率统计
    宏和内联函数
    变量的生存期和存储分配
  • 原文地址:https://www.cnblogs.com/xiketang/p/14275552.html
Copyright © 2011-2022 走看看