注释码

由 Nicolena 于星期四, 2009/05/07 - 10:39 发表

你看过赛车引擎盖下面的摆设么？里面的各种附加功能数不胜数。还记得你第一次看到 PHP, CSS, 或HTML 代码时的感觉么？相信你一定也是一头雾水。所以一定要记住，公开发布你的主题和样式时，用户可能也只是“打开引擎盖随便看看”，然后无奈地离开。

注释或注释码是代码的一部分，它们能够帮助设计人员和用户从杂乱的代码中解脱出来，找到自己需要的内容。

HTML或PHP页面（PHP代码范围外）的注释是这样的：

<!-- comment here about what is going on -->

CSS文件中的注释则是这样的：

/* comment here about a style */

PHP代码内的注释是这样的：

<?php the_excerpt(); // Show excerpt and not full post content ?>

也可能是这样的：

<?php /* This is my special hack.
         It's so special it requires a comment that spans multiple lines! */

my_special_hack();
?>

WordPress 1.5版本发布新的模块化模板系统后，CSS样式就可以进行跨文件交叉了。因此在代码跨模板文件时查找引用所在的版块，的确是件令人沮丧的事，尤其是对那些不熟悉代码的人来说。在开放的div或class中（如下所示）添加注释不是必要条件，但会带来很多帮助：

<div id="sidebar"><!-- sidebar begins -->

大多数了解HTML和CSS的人都知道，id 表示代码块的开始，因此注释可能会显得多余，但如果在每个WordPress主题的每个WordPress主循环的代码开始部分都添加上注释，就会带来很多好处了：

<!-- WordPress Loop begins here -->

在每个div特别是跨模板文件div的结尾部分，添加结尾注释也是很友好的行为：

</div> <!-- end content -->

一些主题在 header.php, index.php 或 single.php file，以及styles.css 外部等主题文件中含有CSS内联样式表。

例如，假设所有样式代码都在style.css文件中，而有人想要修改你精心设计并测试过的主题。你在模板文件中添加任何样式后，最好在style.css中加入关于改动的注释，以便用户查找。试图改变样式却不成功，最后发现设计者在文件的header部分已经改写了样式，没有比这更令人泄气的事了。

你可以添加一个这样的简单注释：

/* Styles for the header image are found within the header.php file. */

这和创建独特的主题设计几乎同样重要，因为它能帮助用户使用你的主题。

测试模板标签、插件标签或不同代码时，有时可能不希望这些标签显示或初始化（被激活）。你可以用注释码将这些标签“藏”起来，删除注释码就可以还原他们的激活情况。

隐藏或禁用HTML：

<!-- <div class="redblock"><p>This is some HTML in
the redblock class.</p></div> -->

隐藏或禁用CSS样式：

/* .redblock {font-size: 80%; font-style: italic; color: red; } */

在模板文件中隐藏或禁用PHP代码：

<?php // the_content(Continue Reading...); ?>

or

<?php /* the_content(Continue Reading...); */ ?>

WordPress啦!