php代码中注释的含义

最近在梳理和优化手上的项目代码,这个项目已经走过好几任了,每一任的开发人员多多少少都有一些差异和各自的习惯,所以代码逻辑和写法上都有点【乱】。

在代码中,注释是一个非常重要的信息,更何况是接手其他人的项目,注释不仅仅是简单的一些文字描述,更包含了更深层次的意思,我们一起来看看几种常见的注释的含义。

TODO: + 说明
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

FIXME: + 说明
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

XXX: + 说明
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

了解到这些注释的特殊含义,可以为项目开发提供很大的帮助,当然了,我们自己也可以在项目中合理的使用这些特殊的注释,为以后其他人接手项目提供便利。

原文地址:https://www.cnblogs.com/firstlady/p/10598548.html

时间: 2024-08-27 19:49:52

php代码中注释的含义的相关文章

python学习之——计算给出代码中注释、代码、空行的行数

题目:计算给出代码中注释.代码.空行的行数 来源:网络 思路:注释行以 ‘#’开头,空行以 ‘\n’ 开头,以此作为判断 def count_linenum(fname): fobj = open(fname,"rU") #print fobj.readlines() count_blankline = 0 count_notes = 0 count_code = 0 for eachLine in fobj: if eachLine[0] == '\n': count_blankli

CSS代码中注释的3种方法

1.选择器(child selector) 如果你想在IE中隐藏一个CSS定义,可以使用子选择器.css部分: html>body p {/* declarations */} 2.“通配符”(*) 这种写法只有IE浏览器可以理解(对其他浏览器都隐藏)css部分: * html p {/* declarations */} 3.“反斜线”(\) 如果你希望IE/Win有效而IE/Mac隐藏,可以使用“反斜线”技巧.css部分: /* \*/* html p {declarations}/* */

python 代码中log表示含义

log表示以e为底数的对数函数符号.其验证代码如下: a=np.log(np.e )print(a)print(np.e) 原文地址:https://www.cnblogs.com/tangjunjun/p/11506187.html

代码中特殊的注释技术——TODO、FIXME和XXX的用处 (转载)

转自:http://blog.csdn.net/reille/article/details/7161942 作者:reille 本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处. 本文内容概要: 代码中特殊的注释技术——TODO.FIXME和XXX的用处. 更多请关注:http://velep.com/ ——————————————————————————————————————————————————————————————————— 前言:

代码中特殊的注释技术——TODO、FIXME和XXX的用处 (转载)

转自:http://blog.csdn.net/reille/article/details/7161942 作者:reille 本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处. 本文内容概要: 代码中特殊的注释技术——TODO.FIXME和XXX的用处. 更多请关注:http://velep.com/ ——————————————————————————————————————————————————————————————————— 前言:

【转】代码中特殊的注释技术——TODO、FIXME和XXX的用处

(转自:http://blog.csdn.net/reille/article/details/7161942) 作者:reille 本博客网址:http://blog.csdn.net/reille/,转载本博客原创文章请注明出处. 本文内容概要: 代码中特殊的注释技术--TODO.FIXME和XXX的用处. 更多请关注:http://velep.com/ --------------------------------------- 前言:今天在阅读Qt  Creator的源代码时,发现一些

代码中特殊的注释技术——TODO、FIXME和XXX的用处

本文内容概要: 代码中特殊的注释技术——TODO.FIXME和XXX的用处.   前言:今天在阅读Qt  Creator的源代码时,发现一些注释中有FIXME英文单词,用英文词典居然查不到其意义!实际上,在阅读一些开源代码时,我们常会碰到诸如:TODO.FIXME和XXX的单词,它们是有其特殊含义的.. TODO: + 说明:如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明. FIXME: + 说明:如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不

@有两个含义:1,在参数里,以表明该变量为伪参数 ,在本例中下文里将用@name变量代入当前代码中2,在字串中,@的意思就是后面的字串以它原本的含义显示,如果不

@有两个含义:1,在参数里,以表明该变量为伪参数 ,在本例中下文里将用@name变量代入当前代码中 2,在字串中,@的意思就是后面的字串以它原本的含义显示,如果不加@那么需要用一些转义符\来显示一些特殊字符 举例1:(2) stringsql ="update Table1 set name [email protected] where ID = '1'";//未采用SqlParameter SqlParameter sp =newSqlParameter("@name&q

java中代码的注释和快捷键

java中代码的注释和快捷键 添加必要的注释,对一个有责任心.有道德模范的前端必须具备的好习惯, 可以大大提高代码的可维护性.可读性. java代码注释快捷键:ctrl+shift+/首先熟悉一下html.css.js的注释的写法:1.HTML注释语法: <!--注释的内容--> 2.css注释语法 /* 注释内容 */ /* ----------文字样式开始---------- */ 3.javaScript注释 //注释内容 /*注释内容*/ 接下来是对注释在这几种代码中使用的位置,如何写