C#注释的一些使用方法浅谈

C# Coding的时候，常常涉及代码注释，常见的注释包括两类：
1）单行注释。格式：// Comments
2）多行注释。格式：/* Comments... */
C#引入了新的XML注释，即我们在某个函数前新起一行，输入///，VS.Net会自动增加XML格式的注释，这里整理一下可用的XML注释。
XML注释分为一级注释（Primary Tags）和二级注释（Secondary Tags），前者可以单独存在，后者必须包含在一级注释内部。
I 一级注释
1. <remarks>对类型进行描述，功能类似<summary>，据说建议使用<remarks>;
2. <summary>对共有类型的类、方法、属性或字段进行注释；
3. <value>主要用于属性的注释，表示属性的制的含义，可以配合<summary>使用；
4. <param>用于对方法的参数进行说明，格式：<param name="param_name">value</param>；
5. <returns>用于定义方法的返回值，对于一个方法，输入///后，会自动添加<summary>、<param>列表和<returns>；
6. <exception>定义可能抛出的异常，格式：<exception cref="IDNotFoundException">；
7. <example>用于给出如何使用某个方法、属性或者字段的使用方法；
8. <permission>涉及方法的访问许可；
9. <seealso>用于参考某个其它的东东:)，也可以通过cref设置属性；
10. <include>用于指示外部的XML注释；
II 二级注释
1. <c> or <code>主要用于加入代码段；
2. <para>的作用类似HTML中的<p>标记符，就是分段；
3. <pararef>用于引用某个参数；
4. <see>的作用类似<seealso>，可以指示其它的方法；
5. <list>用于生成一个列表；
另外，还可以自定义XML标签

赞 (0)

相关推荐

  • C# 基础入门--注释

    注释,是代码中的一些"说明性文字".注释本身不会参与程序的编译和运行,仅仅供程序员阅读. 注释分为:单行注释.多行注释.文档注释. 单行注释的符号是2条斜线"//",2条斜线右侧的内容就是注释,左侧的代码不会受影响. 多行注释以"/*"开始,以"*/"结束,之间的内容就是注释,可以包含多行. 文档注释写在类.方法或属性的前面,它的符号是3条斜线"///". namespace Test { /// <

  • 使用C#给PDF文档添加注释的实现代码

    使用C#给PDF文档添加注释的实现代码

    整理文档时,我们可能会需要在一些或一段文字上添加注释加以说明,那如何以编程的方式实现呢?本文将实例讲述C#中如何使用免费组件给PDF文档添加文本注释,包括自由文本注释.自由文本注释能允许我们自定义它的风格和外观,非常具有实用价值. 首先,下载这个免费版组件Free Spire.PDF.组件下载安装后,Visual Studio创建C#控制台项目,添加bin文件夹的.DLL作为引用以及以下命名空间: using System; using System.Drawing; using System.

  • C#实现为类和函数代码自动添加版权注释信息的方法

    本文实例讲述了C#实现为类和函数代码自动添加版权注释信息的方法,分享给大家供大家参考之用.具体方法如下: 以web项目为例: 一:给类加注释 1.在visual studio 的安装路径下 如:[盘符]:/Program files/Microsoft Visual Studio 8/Common7/IDE/ItemTemplates/web/cshare/2052/class.zip ,将里面的class.cs改为: /*------------------------------------

  • 在C#里面给PPT文档添加注释的实现代码

    在C#里面给PPT文档添加注释的实现代码

    平常开会或者做总结报告的时候我们通常都会用到PowerPoint演示文稿,我们可以在单个幻灯片或者全部幻灯片里面添加注释,这样观众可以从注释内容里面获取更多的相关信息. 有些朋友不清楚如何在幻灯片里面添加注释,下面我跟大家分享一下如何在C#里面为幻灯片添加注释. 在这里我使用了一个免费控件--Free Spire.Presentation,有兴趣的朋友可以下载使用. 需要添加的命名空间: using Spire.Presentation; using System.Drawing; 详细步骤和代

  • C#的XML两种代码注释实例说明

    C#的XML两种代码注释实例说明

    在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即以/*开头,以*/结尾. 在Java中,多行注释(Multiline Comment)分为两种形式: 1.普通多行注释,比如 复制代码 代码如下: /* *多行注释 */ 2.Javadoc注释,比如 复制代码 代码如下: /** *Javadoc注释 */ 当Java源文件编译的时候,Javadoc工具会读取源文件当中的Javadoc注释内容,并生成相应的HTML文档.供开发者参阅API相关的内容.

  • c#删除代码中的单行注释行示例

    复制代码 代码如下: using System.IO; using System.Collections; static string deleteComments(string s) //去掉以//开始的注释 { if (s == null) return s; int pos = s.IndexOf("//"); if (pos < 0) return s; return s.Substring(0, pos); }if (Directory.Exists("Tem

  • C#制作鹰眼的详细全过程(带注释)实例代码

    axMapControl1是主控件,axMapControl2是鹰眼控件 要看清楚事件响应 1.鹰眼地图资源载入 复制代码 代码如下: privatevoid axMapControl1_OnMapReplaced(object sender, IMapControlEvents2_OnMapReplacedEvent e) { //当主地图显示控件的地图更换时,鹰眼中的地图也跟随更换 axMapControl2.LoadMxFile(axMapControl1.DocumentFilename

  • c#文件操作示例带详细注释

    复制代码 代码如下: using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.IO; namespace Example { class Program     { static void Main(string[] args)         {             ////////////////   文件打开  下面的代码打开D:\wang.tx

  • c#中xml文档注释编译dll引用到其它项目示例

    复制代码 代码如下: <#@ template debug="True" hostspecific="True" language="C#" #><#@ assembly name="System.Core" #><#@ assembly name="System.Data" #><#@ assembly name="System.xml" #&

  • C#注释的一些使用方法浅谈

    C# Coding的时候,常常涉及代码注释,常见的注释包括两类:1)单行注释.格式:// Comments2)多行注释.格式:/* Comments... */C#引入了新的XML注释,即我们在某个函数前新起一行,输入///,VS.Net会自动增加XML格式的注释,这里整理一下可用的XML注释.XML注释分为一级注释(Primary Tags)和二级注释(Secondary Tags),前者可以单独存在,后者必须包含在一级注释内部.I 一级注释1. <remarks>对类型进行描述,功能类似&

  • javascript中call和apply方法浅谈

    call和apply的第一个实参是要调用函数的母对象,它是调用上下文,在函数体内通过this来获得对它的引用.例如,如果要想以对象o的方法来调用函数f,可以按如下的方式使用call和apply方法: 复制代码 代码如下: f.call(o); f.apply(o); 可以按如下的代码来理解: 复制代码 代码如下: o.m = f; //将f存储为o的临时方法 o.m(); //调用这个临时方法 delete o.m; //将这个临时方法删除 来个示例吧. 复制代码 代码如下: function

  • 通过String.intern()方法浅谈堆中常量池

    简介 String是我们最常用的一个类,和普通java类一样其对象会存在java堆中.但是String类有其特殊之处,可以通过new方法生成,也可以通过带引号的字符串常量直接赋值.在JDK7之前,字符串常量是存在永久带Perm 区的,JDK7开始在将常量池迁移到堆中,这个变化也导致了String的新特性,下面我们慢慢进行介绍. String.intern()方法 简单的说,String.intern()方法的作用就是返回常量池中字符串对象,在对该方法进行详解之前,我们看几个创建字符串对象的例子.

  • android中处理各种触摸事件的方法浅谈

    Android里有两个类android.view.GestureDetectorandroid.view.GestureDetector.SimpleOnGestureListener(另外android.widget.Gallery好像是更牛x的OnGestureListener )1)新建一个类继承SimpleOnGestureListener,HahaGestureDetectorListener可以实现以下event事件.boolean onDoubleTap(MotionEvent e

  • 浅谈jquery拼接字符串效率比较高的方法

    实例如下: var roleidArray = new Array(""); for(i = 0; i < rightRows.length; i++) { roleidArray.push(rightRows[i].id); } roleidArray = roleidArray.join(",").substring(1); 代码很简单,我就不做注释了 以上这篇浅谈jquery拼接字符串效率比较高的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,

  • 浅谈Django自定义模板标签template_tags的用处

    浅谈Django自定义模板标签template_tags的用处

    自定义模板标签,过滤器.英文翻译是Customtemplatetagsandfilters.customfilter自定义过滤器今天不在我的记录范围之内,以后用到再看官方文档也不迟. **问题1:**customtemplatetags到底长啥样? customtemplatetags-github Manytemplatetagstakeanumberofarguments–stringsortemplatevariables–andreturnaresultafterdoingsomepro

  • 浅谈idea live template高级知识_进阶(给方法,类,js方法添加注释)

    为了解决用一个命令(宏)给方法,类,js方法添加注释,经过几天的研究.终于得到结果了. 实现的效果如下: 给Java中的method添加方法: /** * * @Method : addMenu * @Description : * @param menu : * @return : cn.yiyizuche.common.base.ResultMsg * @author : Rush.D.Xzj * @CreateDate : 2017-06-12 星期一 18:17:42 * */publi

  • 浅谈Python脚本开头及导包注释自动添加方法

    1.开头:#!/usr/bin/python和# -*- coding: utf-8 -*-的作用 – 指定 #!/usr/bin/python 是用来说明脚本语言是python的 是要用/usr/bin下面的程序(工具)python,这个解释器,来解释python脚本,来运行python脚本的. #!/usr/bin/python:是告诉操作系统执行这个脚本的时候,调用 /usr/bin 下的 python 解释器: #!/usr/bin/env python(推荐):这种用法是为了防止操作系

  • 浅谈mysqldump使用方法(MySQL数据库的备份与恢复)

    #mysqldump --help 1.mysqldump的几种常用方法: (1)导出整个数据库(包括数据库中的数据) mysqldump -u username -p dbname > dbname.sql    (2)导出数据库结构(不含数据) mysqldump -u username -p -d dbname > dbname.sql    (3)导出数据库中的某张数据表(包含数据) mysqldump -u username -p dbname tablename > tabl

  • 浅谈js中子页面父页面方法 变量相互调用

    (1)子页面调用父页面的方法或者变量: window.parent.方法()或者变量名 window.parent相当于定位到父页面  之后的操作和在父页面中写代码一样写 window.parent.aa();//调取aa函数 window.parent.bb;//调取bb变量 例如:想在子页面中得到id为aaa的文本框的值 window.parent.$("#aaa").val();//这种写法的前提是引用了jquery window.parent.getElementById(&q

随机推荐