2.4 给代码添加注释

制作大型网站的时候,每个网页程序员所做的工作都会不同,但却相互依赖其他程序员写的代码。为了在同一个项目中让其他程序员看得明白,常常用注释来说明代码功能。注释代码的内容不会在网页中显示,只起到注释作用,如一个网页中头部用注释来说明该页面的作用和创建日期以及本网页所展示的功能等,让其他程序员或学习者看到注释就知道代码内容。

在前面的代码中,多次出现了注解符,而且在注解内容中,笔者都在前面标记“注解:”,这是为了告诉初学者代码的意义所采用的一种解说代码方法,并不会在网页中显示注解内的内容。注释语法比较容易,可以在单行中存在注释,同时也可以多行一起注释,单行注释的完整语法如下。


<!—这里放注释—>


在一行中,在尖括号中放置感叹号“!”和两个“-”,接下来放置注释内容,最后一定要结束注释,结束注释用两个“-”和另一半尖括号组成,即上面代码表示了单行注释。如果网页代码中只需要注释一行,可以用上面的注释。如果有多行同时需要注释,那是不是每行都用尖括号包围呢?答案是不需要的。其实还有一种方法可以注释多行,请看下面代码。


<!—

这里放注释

第二行注释

第三行注释

—>


即在注释处以“<!—”开始,在多行后用“—>”结束,中间的内容就是注释内容,不会在网页中显示。多行注释与单行注释类似,只不过中间多次换行,值得注意的是注释标记对的结束标记一定不要忘记。

下面用实例来演示在HTML代码中包含注释,包括单行和多行的,然后通过内容的显示了解被注释的内容是否在网页中显示,代码2.4表示在两行代码里包含注释,请读者观察能不能从显示的网页中看到注释。

代码2.4 源代码\第2章\注释.html


———————————————-文件名:注释.html———————————————-

01 <html>

02 <head>

03 <title>注释</title>

04 </head>

05 <body>

06 注释代码是看不到的!

07 <!—注释标记,这里是多行注释

08 这里放注释

09 第二行注释

10 第三行注释

11 —>

12 <br>

13 上面有注释,你看到了吗?

14 </body>

15 </html>


【代码解析】在代码2.4的第5行<body></body>标签内输入的文字有多行,基本都被注释掉了,没有被注释的已显示,而被注释的代码没有看到,这就是注释标记在HTML代码中所起的作用,效果如图2.4所示。

2.4 给代码添加注释 - 图1

图 2.4 带有注释的代码

注意 注释的尖括号不能交叉,不要忘记注释符后面的结束符。