PHP中的注释技巧

在PHP程序设计中有两种注释方式，一种是行注释：“// 注释文字”；另一种是块注释：“/* 注释文字 */”。在具体程序设计中怎么去写注释，以什么样的方式写注释比较好呢？下边谈谈我自己的一些感受：）

在我写的大部分代码中，基本原则是：

文件头通常采用块注释；文件主体中采用行注释。

也就是说在每个程序文件的开头，通过块注释将该文件的程序名称、程序作用、程序描述、程序作者及版本等信息写清楚，如下。

<?php
/**
* @desc 文件作用描述
* @autho 剑锋博客
* @version 版本
* @其它
*
*/
?>

在代码主体中采用行注释，如果在代码主体中使用块注释，通过以下方式使用。

<?php
    //*
       php程序代码
    //*/
?>

通过以上这种方式，如果某区域代码需要注释掉，那么只需要将“//*”修改为“/*”，整个代码块都将会变成注释块，如：

<?php
     /*
        php程序代码
     //*/
?>

其实说实在的我都忘记最初我是为什么开始使用这种注释风格了，现在只是习惯这么做了。感觉每当要调试的时候只需要将“/*”改成“//*”，或者将“//*”修改成“/*”既可以在注释块和程序块切换。

其实总的技巧就是将块注释的“*/”修改成“//*/”

作者：思为爸爸分类：WEB应用标签：php 时间：2008年10月20日

杨思为 | 我们一家