.NET注释

.NET中有三种注释:

1.单行注释   //

2.多行注释   /*开始   */结束

3.文档注释  在类或方法前面敲  ///

///

///文档注释

///

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace 注释
{
    class Program
    {
        /// <summary>
        /// 这个方法是程序的入口  这里是文档注释
        /// </summary>
        /// <param name="args"></param>
        static void Main(string[] args)
        {
            //这里是单行注释

            //下面定义了一个整型变量num,并赋值  应该在具体的程序中说明这个变量的作用
            int num = 10;

            /*
             * 这里是多行注释
             * 这里是多行注释
             * 这里是多行注释
             */

            SayHello();
        }

        /// <summary>
        /// 这个方法是向屏幕打印“Hello World!”
        /// </summary>
        static void SayHello()
        {
            Console.WriteLine("Hello World!");
        }
    }
}

我们在方法前面加上文档注释,这样我们在调用的时候,vs就会提示我们,这样我们一看就能知道这个方法是做什么。

注释不会被执行,有时候调试代码的时候可以将某些代码暂时注释,可以很快发现问题。

注释是给人看的,应能起到提示解释作用,目的是让自己和别人都能看懂,告诉别人或提醒自己这个变量或这个方法是做什么用的。注释一方面是给别人看,一方面是给自己看,人的记忆没有那么好,总有忘记的时候,如果我们添加了注释,过一些时间,我们再回来看我们自己写的代码的时候,一看注释便很快就能回想起来。所以写好代码注释不仅别人受用,你自己也会受益匪浅。

有时候看一个程序员水平的高低,看他的注释就能看出来。平时养成写注释的习惯对程序员来说是非常重要的。

.NET注释

时间: 2024-08-27 13:38:54

.NET注释的相关文章

Python_01_变量_注释_input_if_缩进

个人笔记,仅作学习记录,如有错误烦请指正 变量命名规则: 1:变量名必须以英文字母.下划线.数字组成的组合2:变量名开头不能是数字3:变量名不能是Python中的关键字4:变量名不能是中文5:Python中的变量名如有多个单词建议下划线连接(其他语言常用驼峰法)6:Python中无法定义常量:在python里面所有的变量都是可变的,所以用全大写的变量名来表示常量 变量赋值:name1 = "laowang"name2 = name1name1 = "xiaozhang&quo

Java-认识变量、注释并能及时发现错误

package com;//变量的演示public class VarDemo { public static void main(String[] args) { /* * 1)题目不用抄 2)注释不用写 3)有错必须改 * * 练习: * 1)声明一个整型的变量,名为a * 声明两个整型的变量,名为b,c * 2)声明整型变量d并赋值为56 * 声明整型变量e, * 给变量e赋值为56 * 3)声明整型变量f并赋值为5, * 声明整型变量g并赋值为f+20,输出g * 声明整型变量h并赋值为

HTML5 &lt;ruby&gt;注释标签

今天学了HTML5的ruby标签,觉得挺有趣的,来记录一下. ruby可以作注释标签,内部有rp和rt标签. <ruby>  标记定义注释或音标. <rp>    告诉那些不支持ruby元素的浏览器该如何显示. <rt>      标记定义对ruby注释的内容文本. 学完这个标签的第一反应就是,我有方法给那些不会读的日语单词做假名注释啦!!! 代码如下,来给一句日语做个小注释: <!DOCTYPE html> <html lang="en&q

IE条件注释

条件注释是IE专门提供的一种语法,其他浏览器会将其作为注释而忽略这些语句. 作用:根据不同的IE版本加载对应的CSS或者JS文件,甚至css代码和html代码. 重要提示 自IE10起,标准模式不再支持条件注释.而是采用特征检测给浏览器不支持的功能来提供备用策略.有关标准模式的详细信息,请参阅定义文档兼容性. 术语 熟悉下列术语有助于你学习文档兼容性. 名词 描述 expression 由运算符.特征和(或)值组合形成一个条件语句 downlevel browser 任何浏览器除了IE5+,其他

Java注释

注释(commentary )是程序中用于说明和解释的一段文字对程序运行不起作用.程序 中添加注释的目的是增强程序的可读性. Java提供3种注释方式:. 单行注释:// 多行注释/**/ 文档注释: /** *文档注释用于从源代码自动生成文档执行javadoc *命名根据源代码中的内容生成网页 *@XXX <-- 可以加入javadoc参数产生相应的文档 */ 不同格式的注释可以嵌套. // Welcome1.java. Text-printing program. /*计信学院09软件工程2

Eclipse注释模板设置详解

设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素.本文现就每一个元素逐一给大家介绍一下. 文件(Files)注释标签: 1 2 3 4 5 6 7 8 /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author $

delphi 属性 参数 新注释

delphi 属性 参数 新注释,在写代码的时候,可以自动看到属性.参数的的备注说明,太方便了. Tmyclass=class /// <summary> /// 姓名 /// </summary> name:string; /// <summary> /// 性别 /// </summary> sex:string; end; var aclass: Tmyclass; begin aclass.name; aclass.sex; 鼠标放上去的时候提示 写

vi/vim多行注释和取消注释

多行注释: 1. 进入命令行模式,按ctrl + v进入 visual block模式,然后按j, 或者k选中多行,把需要注释的行标记起来 2. 按大写字母I,再插入注释符,例如// 3. 按esc键就会全部注释了 取消多行注释: 1. 进入命令行模式,按ctrl + v进入 visual block模式,按字母l横向选中列的个数,例如 // 需要选中2列 2. 按字母j,或者k选中注释符号 3. 按d键就可全部取消注释 对单行注释:CTRL_C对多行注释: 先”V”,进入块选择模式.选择一段代

Qt的语法高亮类(注释方式)

1 //语法高亮---QSyntaxHighlighter 2 //highlighter.h 3 class Highlighter : public QSyntaxHighlighter //定义一个类继承自QSyntaxHightliaghter 4 { 5 Q_OBJECT //Qt宏定义,使用Qt元编程 6 7 public: 8 Highlighter(QTextDocument *parent = 0); //构造函数,传递一个QTextDocument对象给其父类 9 10 pr

QT学习 之 对话框 (四) 字体对话框、消息对话框、文件对话框、进程对话框(超详细中文注释)

QMessageBox类: 含有Question消息框.Information消息框.Warning消息框和Critical消息框等 通常有两种方式可以来创建标准消息对话框: 一种是采用“基于属性”的API,一种是使用QMessageBox的静态方法. 后者书写容易,但缺少灵活性,针对用户给出的提示的信息不够丰富,并且不能自定义消息对话框里面的按钮提示信息.因此推荐第一种写法. [cpp] view plaincopy <span style="font-size:18px;"&