给C#程序添加说明——注释
来源:互联网 发布:无硅油洗发水品牌知乎 编辑:程序博客网 时间:2024/06/05 07:00
作为程序开发者,编写代码不仅要自己能够看懂,小组成员和其他人员也要看明白。如果不对代码添加说明信息,也许我们自己过一段时间后都不明白自己当时编写的是什么,这是一件很糟糕的事。为了避免这种情况,程序员的一个非常重要的工作就是给程序添加说明信息,也就是注释。
C#提供了多种注释类型:
单行文本注释:
在程序中"//"描述一个单行的文本注释,我们一般写在语句后部或上部。
//单行文本注释
多行文本注释:
在程序中"/* ---------*/ "这样描述一个多行文注释。
/*
一场地震,生死两难;
只道三四险,不知五月难;
纵有六双眼,泪也流不完;
七颗心儿悬,零八奥运艰;
高呼九洲十地华人现,纵使百舸千帆风浪间,也让咱行得万年船!
*/
XML文档注释:
XML文档注释一般都写在方法或类的上部,在VS中,只需要连续输入三个"///"就可以自动生成一段XML文档注释,格式如下:
/// <summary>
/// 这是一个Main方法,是C#应用程序的入口.程序控制在该方法中开始和结束.
/// </summary>
/// <param name="args"></param>
static void Main(string[] args)
{
}
说明:其中 summary是对这个方法或类的说明,摘要<param name="args"></param>是指方法的当前有一个参数。
添加注释行的代码Program.cs:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
namespace HelloWorld{
///<summary>
///这是第一个控制台应用程序,实现简单输出功能
///<summary>
class Program{
static void Main(string[] args) //这是程序入口点
{
/*
这是添加的关键代码
*/
Console.WriteLine("HelloWorld"); //向控制台输出HelloWorld
Console.ReadLine();
}
}
}
当在一个方法前面输出“///”时,会自动产生文档注释,这种注释可导出成XML文档
- 给C#程序添加说明——注释
- 给C#程序添加说明——注释
- 在C#里面给PPT添加注释
- C#给自己写的方法添加注释提示
- C#中给函数添加注释小技巧
- 给C#2010程序添加图标
- 按照Doxygen工具规范给程序添加注释
- C# 注释及说明
- C# 注释及说明
- C#注释及说明
- C#如何给自定义控件添加说明(解释)
- 如何自动为C#程序文件添加版权信息注释
- 给vi自动添加注释
- oracle给字段添加注释
- iOS 给代码添加注释
- mysql给表添加注释
- 【菜鸟看框架】——如何给EF实体添加注释
- 随手——给自定义view的自定义属性添加注释
- GIT版本配置管理
- C#中的Main(String[] args)的意思
- 查找高亮
- Oracle边导出边压缩方法
- Android_001_搭建开发环境_NetBeans
- 给C#程序添加说明——注释
- DB2备份还原
- 【观点】创业编程七个错误认识
- PE,PB 动态PE,PB
- Android_002_第一个简单的程序
- winform 制作安装程序,及程序的升级
- 创建一个控制台应用程序
- 十八个绝招把你从压力中营救出来
- 自我激励的方法