php代码中注释的含义

Posted 2021-11-08 firstlady

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

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

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

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

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

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