2.3 添加代码注释;2.4 术语

来源:互联网 发布:EF值simpson算法 编辑:程序博客网 时间:2024/06/13 16:06

编译器编译程序时不执行注释的代码或文字。注释可以分为对单行代码进行注释、对多行代码注释和给代码添加说明三种,单行注释都以“//”开头,多行注释“/*”开始,以“*/”结束,使用“///”标记给代码段添加说明。


使用“//”标记可以注释单行代码,使用“///”标记也可以注释单行代码,而且“///”标记单行注释的使用方法几乎与“//”标记相同。如果在某一行中出现“///”标记,那么“///”标记所在行后面的内容均为注释内容。但是“///”标记很少用于单行代码的注释,“///”标记一般用于为代码段添加说明。

可以在<summary>和</summary>之间添加方法的描述,在<param>和</param>之间添加参数的描述,在<returns>和</returns>之间添加返回值的描述。

【例2.8】在“欢迎您来到C#语言世界!”程序中使用“///”注释,实现代码如下。

01   namespace ConsoleApplication1
02   {
03       ///<summary>
04       ///定义Program类
05       ///</summary>
06       class Program
07       {
08           ///<summary>
09           ///程序入口方法
10           ///</summary>
11           ///<param name="args">用于向方法传递的参数</param>
12           ///<returns>方法无返回值</returns>
13           static void Main(string[] args)
14           {
15               Console.WriteLine("欢迎您来到C#语言世界!");
16               Console.ReadLine();
17           }
18       }
19   }


技巧 “//”标记不仅可以为代码段添加说明,它还有一项更重要的工作,就是用于生成自动文档。自动文档一般用于描述项目,使项目更加清晰直观。在Visual Studio 2010中可以通过设置项目属性来生成自动文档。具体的步骤如下:在“解决方案资源管理器”对话框中右击项目,在弹出的快捷菜单中选择“属性”命令,再在弹出的对话框中选择“生成”选项卡,然后在“输出”栏中选中“XML文档文件”复选框,最后重新调试程序,便可以生成XML文档。生成的XML文档的默认存储路径为当前程序的bin\Debug文件夹下。

在Visual Studio 2010开发环境中,可以使用#region和#endregion关键字指定可展开或可折叠的代码块,这样可以使程序更好的布局。

【例2.9】在“欢迎您来到C#语言世界!”程序中使用“#region”和“#endregion”注释,实现代码如下。

01   #region
02   static void Main(string[] args)
03   {
04       System.Console.WriteLine("欢迎您来到C#语言世界!"); //输出信息
05       System.Console.ReadLine();    //等待读入信息
06   }
07   #endregion

2.4 术语


(1)命名空间既用做程序的“内部”组织系统,也用做向“外部”公开的组织系统(一种向其他程序公开自己拥有的程序元素的方法)。

(2)类是一种数据结构,它可以封装数据成员、函数成员和其他的类。

(3)标识符是指在程序中用来表示事物的单词。

(4)关键字是指在C#语言中具有特殊意义的单词,它们被C#设定为保留字,不能随意使用。


0 0
原创粉丝点击