在程序员的编程工作中,明了清晰的注释是至关重要的。一般一段复杂的代码经过一段时间后,即使是自己当时绞尽脑汁想出的代码,可能还是会忘得一干二净,这时如果当时做了注释,就能帮助我们快速回忆起当时的编程思路和需求背景的内容,可以快速的投入修改和功能添加等工作中。 注释一般常用的有以下几种。1, 单行注释;2, 多行注释,标注类的内容,变量信息等;3, 长段注释,描述需求,版本信息等。
工具/原料
Microsoft Visual Studio 2010
方法/步骤1
1
打开Microsoft Visual Studio 2010, 新建名字为【注释示例】的程序。
3
多行注释示例:一般用在类的前面,以【///】开头,描述该类的作用,类中使用到的变量,类使用时的注意事项和引用位置等等。如下图中对output类的注释。
4
长段注释示例:使用一大段文字描述较多的信息。比如可用于版本更新的介绍,程序需求等内容。如下图所示,为各个版本修改的内容,修改的日期等。
上一篇:如何读懂程序代码
下一篇:编写优秀代码的10个技巧