注释你的代码
注释是帮助我们使用的很好的工具(提示)。注释不仅使我们可以说明代码段落,而且它提供了更简单的方法去编辑代码。在开发者的书里一种古老的窍门用于吸引注意力就是在那些文章,图像或是编码段落中添加注释。
例如:假设你在一家网站工作每天(周)需要更新网页。如果你使用代码编辑器,你必须把文章插入到指定的网页中。这可以使过程更为快速,而且更容易知道在那里插入,加入有了注释以上的这些都将变得容易。
<!-- ---------- INSERT STORY 1 HERE ------------ -->
The extra dashes are used to draw your attention to the comment line. You can just as easily use something like this:
<!-- INSERT STORY 1 HERE -->
You might even want to use something more eye-catching, such as:
<!-- ####### INSERT STORY 1 HERE ####### -->
对于一些不熟悉在HTML中使用注释的人,“<!--“就是注释的开始而“-->”就是注释的结束。所有这中间的将不会在浏览时出现,也不会改变代码的意义。养成在代码中使用注释的习惯对你初步设计HTML代码和希望指出你要设计的网页时很有作用。
例如,有一个程序员使用很多年的窍门。假使你在等一个HEML文档,而且你添加了表格希望看看效果。如果你不喜欢――但是你希望以后使用这表――你可以注释它而不是删除整个段落而且必须重写一遍,然后关掉注释。当你希望使用的时候,你仅仅只需取出注释部分。就是这么容易!
一条好的HTML文件需要有完整的注释。在开始或是每个代码段落,都需要有注释。这不是痛苦的过程,而且不需要很多时间,但是好处却是有很多的。
这有些帮助读者了解HTML文档格式中注释的范例。相信我――你回去时你会受益匪浅并有改变。
<!-- ---------- BEGIN SIDE BAR HERE ------------ -->
<!-- ------------ END SIDE BAR HERE ------------ -->
<!-- ------------ This section of JavaScript calculates the user’s Operating System ------------ -->
<!-- ---------- MAIN TABLE ------------ -->
好的注释也帮助别人去理解你的代码。好的注释的HTML文档可以让只有很少编程经验的人完全德明白美一部分HTML的作用。
当你不希望你的HTML的某一部分不被改变时注释也特别的便利。我会详细注释出我的代码的开始和结束。这样,不会造成首尾的混乱。现面有些例子:
<!-- @@@@@ BEGIN - DO NOT ALTER THIS SECTION @@@@@ -->
(Here’s where you’d list the commands you don’t want altered.)
<!-- @@@@@ END - DO NOT ALTER THIS SECTION @@@@@ -->
HTML heaven!
这就是对于你的HTML看起来应该怎样的建议。使用这些建议去创建清晰的有注释的HTML,你将会使电脑空间更加美好。
