《ActionScript 3.0基础教程》——2.3 代码注释

简介:

本节书摘来自异步社区《ActionScript 3.0基础教程》一书中的第2章,第2.3节,作者: 【美】Doug Winnie 更多章节内容可以访问云栖社区“异步社区”公众号查看。

2.3 代码注释

注释是你开发过程中非常重要的部分,它可以帮助你或者你的队友了解代码的含义。注释包括注意、提示、代码解释等。这样其他人就能了解代码的意思了。

就算你是独自一人工作,注释也能在你停止某项目一段时间后又想要返回项目时帮助你理解曾经写下的代码,很多程序员会在工作时写很复杂的代码,当时会记得很清楚,但是在几个月之后他们发现这些代码的意思他们自己已经忘记了。

2.3.1 创建注释
在Flash中你有两种创建注释的方法。第一种是一行的注释。这样的注释用"//"创建,任何在双斜杠后面的内容(注意只在这一行),将不会被Flash执行。比如:

// This code creates a blue circle on the screen
var myCircle:BlueCircle = new BlueCircle();
addChild(myCircle);
trace(myCircle);

在这个例子里,第一行是注释,不会被Flash所执行。

第二种类型的注释是多行注释。你需要使用特殊的符号放在句子的开头和末尾来创建这样的注释,符号是"/"和"/"。这组符号中的所有语句将不被Flash执行。比如:

/* This code creates a blue circle
  on the screen at 150,100 */
var myCircle:BlueCircle = new BlueCircle();
myCircle.x = 150;
myCircle.y = 100
addChild(myCircle);
trace(myCircle);

在"/"和结尾"/"中间的语句将不被Flash所执行,这中间的内容你想要多长都可以。你也许看见过一些代码使用过这样的符号,它们都有相同的作用,把符号中间的所有内容注释掉。

2.3.2 空格的作用
通常情况下,你可以在代码中使用空格,如空格、tab、回车。这样做有时可以很好的排列代码。通常我们会在一组相同意义的代码前加入注释。在代码中如何很好的使用tab来规范代码,本书会在以后的章节提到。

蓝色圆圈的例子我们可以这样来扩展一下,让它更加的清晰、易读:

/* This code creates a blue circle
  on the screen at 150,100 */
// Create a new instance of the BlueCircle class
var myCircle:BlueCircle = new BlueCircle();
// Position the myCircle on the screen
myCircle.x = 150;
myCircle.y = 100;
// Add myCircle to the display stack
addChild(myCircle);
// Send myCircle to the Output panel to confirm it is there
trace(myCircle);
相关文章
|
8月前
|
SQL XML 数据库
C#OOP之十六 开发常用之各种规范参考
C#OOP之十六 开发常用之各种规范参考
36 0
|
4月前
|
JavaScript 前端开发 Java
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
220 0
|
6月前
|
SQL 开发框架 .NET
CodeSmith 简单使用和常用模板
CodeSmith 简单使用和常用模板
20 0
CodeSmith 简单使用和常用模板
关于Markdown编辑器的一些简单使用语法
关于Markdown编辑器的一些简单使用语法 Markdown编辑器的日常使用其实还是比较方便的,语法也不会过于复杂。在Markdown编辑器中,常用的标记符号不超过10个,只需要少量的时间就可以轻松掌握。 创建标题 标题是文章中最常用的格式之一,在Markdown编辑器中,如果我们想创建一个标题,只需要输入符号#,在符号#之后空一格然后输入标题名称。Markdown编辑器最多支撑到6级标题,符号#的数量就是对应标题的等级。
82 0
ADI
[随笔]Electorn 代码片段
[随笔]Electorn 代码片段
ADI
108 0
|
XML Java 程序员
小白趣读PEP| 优雅的代码往往不是用手写出来的
小白趣读PEP| 优雅的代码往往不是用手写出来的
120 0
小白趣读PEP| 优雅的代码往往不是用手写出来的
|
JavaScript 前端开发
JavaScript 编程精解 中文第三版 十七、在画布上绘图
十七、在画布上绘图 原文:Drawing on Canvas 译者:飞龙 协议:CC BY-NC-SA 4.0 自豪地采用谷歌翻译 部分参考了《JavaScript 编程精解(第 2 版)》 绘图就是欺骗。
1921 0
|
Android开发
36个Android开发常用代码片段
常用代码片段 //36个Android开发常用代码片段 //拨打电话 public static void call(Context context, String phoneNumber) { context.
840 0
《C++语言入门经典》一1.3 如何使用本书代码
本节书摘来自华章出版社《C++语言入门经典》一书中的第1章,第1.3节,作者 郭鑫 顾彦玲,更多章节内容可以访问云栖社区“华章计算机”公众号查看
1180 0