PHP 代码注释

写在前面

注释可以理解成代码中的解释和说明。使用注释不仅能提高程序的可读性,而且有利于程序的后期维护工作,注释内容不会被程序所执行。

个人项目

个人站点:<a href="http://film.noasis.cn">LN电影网</a>
个人博客:<a href="http://blog.noasis.cn">L&N博客</a>

PHP 的注释

PHP 注释有 3 中风格

1. C++ 风格的单行注释 (//)

// 这是一条注释信息:打印 hello world
echo 'hello world';

2. C++ 风格的多行注释 (/**/)

 /* 这是一个多行注释
       echo '你好';
       echo ‘这个世界’;
    */

echo "你好这个世界";

3. 使用 Shell 风格的注释(#)

跟 单行注释类似,# 所在行不会被执行

echo '你好这个世界'; # shell 风格注释,这里的内容不会被执行

PHP 的有效注释

程序注释是书写规范程序是很重要的环节。注释主要是针对代码的解释与说明,主要作用如下:解释脚本用途、版权说明、版本号、生成日期、作者、内容等等。有助于对程序的阅读理解

注释原则

语言

  • 注释语言必须准确、易懂、简洁

说明: 错误的注释不但无益反而有害

  • 注释在编译代码时会被忽略,不会被编译器编译到最后的可执行文件中,所以注释不会增加执行文件大小。

  • 注释可以书写在代码中的任意位置,但是一般写在代码的开头或者结束位置

说明:避免在一行代码或者表达式中间插入注释。否则容易产生理解偏差

  • 修改程序代码时,一定要同时修改相关的注释,保证代码和注释的同步

  • 在实际代码规范中,要求注释代码占程序代码的比例达到 20% 左右,即 100 行代码有 20 行注释

说明: 防止不必要的注释

  • 在程序块的结束行右方添加注释,以表明某段程序快结束

  • 避免在注释中使用缩写,特别是非常用缩写

  • 注释与所描述内容同样的缩写,可以使程序排版整齐,并且方便注释的阅读与理解

总结

如果想成为一名严谨、有态度的程序员,这些看似无关紧要的原则其实代表了我们对所编写程序的一种负责态度。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容