zoukankan      html  css  js  c++  java
  • C#注释 -0015

    C类型注释

    C#用的是传统C类型语言的注释,单行用//,多行用/*...*/

    XML文档

    除了C风格的注释外,C#还有一个非常出色的功能:根据特定的注释自动创建XML格式的文档说明。

    这些注释都是单行注释,以三斜杠///开头而不是通常的双斜杠//

    在///注释中,可以把包含类型和类型成员的文档说明的XML标记放在代码中,下面是编译器能识别的标签表:

    标签描述
    <c> 将一行注释文本标记成代码格式,如<c>int i = 10;</c>。
    <code> 将多行注释包含在标记成代码块。
    <example> 标记一个代码例子。
    <exception> 记录一个异常类(语法由编译器验证)。
    <include> 包含其他说明文档里的注释(语法由编译器验证)。
    <list> 在文档中插入一个列表。
    <para> 给出文本的结构。
    <param> 标记方法的参数(语法由编译器验证)。
    <paramref> 标识一个单词是否为一个方法参数(语法由编译器验证)。
    <permission> 记录一个成员的可访问性(语法由编译器验证)。
    <remarks> 追加成员的描述。
    <returns> 记录方法的返回值。
    <see> 提供另外一个参数的交叉引用(语法由编译器验证)。
    <seealso> 在描述里提供一个"另外参见"小节(语法由编译器验证)。
    <summary> 提供一个类型或成员的简要介绍。
    <typeparam> 描述一个泛型类型需要的类型参数。
    <typeparamref> 提供类型参数的名称。
    <value> 描述一个属性。

    注意:VS Code如何想输入///后,自动添加注释结构的话,需要安装VS Code插件:vscode-docomment

    ///注释生成XML文档

    • 在.csproj文件中添加:
     <PropertyGroup>
        <GenerateDocumentationFile>true</GenerateDocumentationFile>
        <DocumentationFile>binYourApi.XML</DocumentationFile>
      </PropertyGroup>
    

      编译后在生成目录中可见.xml文档。

  • 相关阅读:
    编写高质量代码建议17代码错误调试
    同步和异步的不同场景的概念理解
    kafka版本0.8.2.0-Producer Configs之request.required.acks
    linux的grep命令
    jetty服务器访问系统的域名
    linux工具问题,tail -f 失效
    memcached并发处理
    python爬虫scrapy的Selectors参考文档
    访问nginx提示gateway timeout 504 ,发现总是当调用时间超过30s时提示504错误
    重构再次理解
  • 原文地址:https://www.cnblogs.com/codesee/p/13040180.html
Copyright © 2011-2022 走看看