PHP代码注释方法,PHP代码注释

写在前面

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

个人项目

个人站点：LN电影网个人博客：L&N博客

PHP 的注释 PHP 注释有 3 中风格

1. C++ 风格的单行注释 (//) // 这是一条注释信息：打印 hello worldecho 'hello world';

2. C++ 风格的多行注释 (/**/) /* 这是一个多行注释 echo '你好'; echo ‘这个世界’; */echo "你好这个世界";

3. 使用 Shell 风格的注释(#) 跟单行注释类似，# 所在行不会被执行 echo '你好这个世界'; # shell 风格注释，这里的内容不会被执行

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

注释原则

语言注释语言必须准确、易懂、简洁说明：错误的注释不但无益反而有害注释在编译代码时会被忽略，不会被编译器编译到最后的可执行文件中，所以注释不会增加执行文件大小。

注释可以书写在代码中的任意位置，但是一般写在代码的开头或者结束位置说明：避免在一行代码或者表达式中间插入注释。否则容易产生理解偏差修改程序代码时，一定要同时修改相关的注释，保证代码和注释的同步

在实际代码规范中，要求注释代码占程序代码的比例达到 20% 左右，即 100 行代码有 20 行注释说明: 防止不必要的注释在程序块的结束行右方添加注释，以表明某段程序快结束

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

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

总结

如果想成为一名严谨、有态度的程序员，这些看似无关紧要的原则其实代表了我们对所编写程序的一种负责态度。本条技术文章来源于互联网，如果无意侵犯您的权益请点击此处反馈版权投诉本文系统来源：php中文网

PHP代码注释方法,PHP代码注释相关推荐

Android代码混淆方法,Android 代码混淆零基础入门
内容提要本篇文章主要有三个部分,让读者读完后能自己写规则混淆项目对Android代码怎么开启混淆做一个简单的介绍. 对混淆规则做一个简单介绍: 在混淆过后Crash日志反推代码工具retrace. ...
网页中返回顶部代码(多种方法)另附注释说明
下面就说下简单的返回顶部效果的代码实现,附注释说明,最简单的静态返回顶部,点击直接跳转页面顶部及用js模拟滚动效果上滑至顶部下面就说下简单的返回顶部效果的代码实现,附注释说明. 1. 最简单的静态返 ...
返回顶部php代码,网页中返回顶部代码(多种方法)另附注释说明_jquery
下面就说下简单的返回顶部效果的代码实现,附注释说明. 1. 最简单的静态返回顶部,点击直接跳转页面顶部,常见于固定放置在页面底部返回顶部功能方法一:用命名锚点击返回到顶部预设的id为top的元素 f ...
【R - 代码书写习惯、代码注释方法笔记】
前言本篇笔记将总结R的注释方法.代码书写规范建议.干货满满! 今天突然发现自己写的代码可读性不是那么强,有的地方乱糟糟,有的时候还写一大堆注释,没有清晰的区块和条理.知错能改,善莫大焉,我去上网搜索 ...
Python语言中的注释方法应用
Python语言中的注释方法在Python编程中,与其他编程语言一样,有良好的注释部分,会让你的程序在后续的改进或优化中,变得便利.同时,给自己培养了良好的编程习惯. 在Python语言中,有两种注 ...
如何运行一段python代码_Python退出时强制运行一段代码如何实现 Python退出时强制运行一段代码实现方法...
本篇文章小编给大家分享一下Python退出时强制运行一段代码实现方法,代码介绍的很详细,小编觉得挺不错的,现在分享给大家供大家参考,有需要的小伙伴们可以来看看. 设想这样一个场景,你要给一个项目开发测 ...
抖音表白代码制作方法
最近抖音里面流传着一种代码表白小程序,很炫,下面我就为大家分享一下制作教程. 工具/原料: 一台电脑方法/步骤: 1.首先打开电脑. 在电脑桌面用鼠标右键单击新建一个. 抖音表白代码制作方法抖音表 ...
python网站开发换行_python实现换行写代码的方法
python实现换行写代码的方法发布时间:2020-07-02 16:34:06 来源:亿速云阅读:257 这篇文章运用简单易懂的例子给大家介绍python实现换行写代码的方法,代码非常详细,感兴 ...
Java基础篇（标识符、关键字、数据类型、运算符、类型转换、注释方法、扫描器）
一.Java标识符命名规范标识符:用来标识类名.对象名.变量名.方法名.类型名.数组名.文件名的有效字符序列: 合法的标识符:----字母.数字.下划线'_'.美元符号'$'组成:不能用数字开头,不 ...

PHP代码注释方法,PHP代码注释

PHP代码注释方法,PHP代码注释相关推荐

最新文章

热门文章