IOS 之 Swift教程(二) -入门语法(注释)

如果学过其他任何一门语言如Java, Java Script，C#等, 大家对注释一定不陌生。代码注释可以理解成程序设计者和程序阅读者的桥梁,它可以最大限度的提高团队开发的合作效率, 也是程序代码可维护性的重要环节之一。

注释的规范

1、 修改代码时，总是使代码的注释保持最新, 为了防止问题反复出现，对错误修复和解决方法代码必须使用注释。

2、 在每个函数、方法的开始，应该提供标准的注释以指示例程的用途，注释样本应该是解释它为什么存在和可以做什么的简短介绍。

3、 避免在代码行的末尾添加注释；行尾注释使代码更难阅读。

4、 在变量声明时，应在行尾添加注释；在这种情况下，将所有行尾注释应使用公共制表符（Tab）在一处对齐。

5、 避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。

6、 在编写注释时使用通俗易懂的句子。注释应该阐明代码，而不应该增加多义性。

7、 对由循环和逻辑分支组成的代码使用注释。这些可以帮助源代码读者理解代码书写目的。

8、 在所有的代码修改处加上修改标识的注释，创建标识和修改标识由创建或修改人员的姓名加日期组成，如：陈瑞银19941008

9、 为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。

10、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。

注释在代码中的应用

Swift 中的注释与其它语言的注释非常相似。单行注释以双正斜杠（//）作为起始标记:

// 这是一个注释

你也可以进行多行注释，其起始标记为单个正斜杠后跟随一个星号（/），终止标记为一个星号后跟随单个正斜杠（/）:

/* 这是一个,多行注释 */

与 C 语言多行注释不同，Swift 的多行注释可以嵌套在其它的多行注释之中。你可以先生成一个多行注释块，然后在这个注释块之中再嵌套成第二个多行注释。终止注释时先插入第二个注释块的终止标记，然后再插入第一个注释块的终止标记：

/* 这是第一个多行注释的开头/* 这是第二个被嵌套的多行注释 */这是第一个多行注释的结尾 */

通过运用嵌套多行注释，你可以快速方便的注释掉一大段代码，即使这段代码之中已经含有了多行注释块。