Objective-C和Sprite Kit游戏开发从入门到精通
上QQ阅读APP看书,第一时间看更新

2.2 注释

还记得代码中的绿色内容(注释)吗?前面的讨论中,我们都会将注释删除,难道它们真的没什么用吗?

当然不是,在代码中添加注释是一项非常重要的工作,虽然我们常说,代码最好的解释就是代码本身,但是,对于复杂的代码来讲,能通过注释简单地说明一下代码的目的也是一个不错的选择。

在Objective-C代码中,我们可以使用两种注释方法:

❑ 块注释,即将注释内容放在/*和*/之间。

❑ 行注释,使用//开始,到本行的结束都当作注释内容。

下面的内容演示了这两种注释的基本应用。

    /*
        这是块注释
    */
    // 这是行注释
    int x = 10;  // 这也是行注释

这看上去也是很简单的吗?

是的,注释本身并没有什么特别之处,重要的是在代码中如何应用。一般来讲,注释会用于说明代码的目的,如算法和思路的简单说明,但不应该是代码的简单重复。另外,使用一行空注释,可以有效地对代码块进行分割,便于代码的阅读。

大家可以在实践中逐步理解注释的使用特点,并在项目中合理地应用,同时,如果团队中有注释的书写约定,我们也应该严格执行。毕竟,无论是开发过程中,还是在代码维护过程中,我们都经常要阅读代码。