养生 装修 购物 美食 感冒 便秘 营销 加盟 小吃 火锅 管理 创业 搭配 减肥 培训 旅游

C#如何写代码注释

时间:2024-10-01 23:35:28

在程序员的编程工作中,明了清晰的注释是至关重要的。一般一段复杂擢爻充种的代码经过一段时间后,即使是自己当时绞尽悲逻液徙脑汁想出的代码,可能还是会忘得一干二净,这时如果当时做了注释,就能帮助我们快速回忆起当时的编程思路和需求背景的内容,可以快速的投入修改和功能添加等工作中。注释一般常用的有以下几种。1,单行注释;2,多行注释,标注类的内容,变量信息等;3,长段注释,描述需求,版本信息等。

工具/原料

MicrosoftVisualStudio2010

方法/步骤1

1、打开MicrosoftVisualStudio2010,新建名字为【注释示例】的程序。

2、单行注释示例:在需要进行较短的注释时使用,以【//】开头,可以写一行注释内容,注释内容以绿色表示,以便和其它代码做区分。如下图的对按钮的注释。

C#如何写代码注释

3、多行注释示例:一般用在亿姣灵秀类的前面,以【///】开头,描述该类的作用,类中使用到的变量,类使用时的注意事项和引用位置等等。如下图中对output类的注释。

C#如何写代码注释

4、长段注释示例:使用一大段文字描述较多的信息。比如可用于版本更新的介绍,程序需求等内容。如下图所示,为各个版本修改的内容,修改的日期等。

C#如何写代码注释

© 一点知识