PHP注释最佳实践

php, comment

常量方便了全局值替换，也有了可读性的名字，但是背后的说明不一定能完整体现到常量名中，所以最好写上注释，如下：

1
2


    const CONTRACT_TYPE_ELECTRONIC = 0;//合同类型-电子
    const CONTRACT_TYPE_PAPER = 1;//合同类型-纸质

如上注释有个不好的地方，在编辑器 PHPStorm 中，鼠标悬停看不出注释，注释可以做如下调整，即可悬停查看

1
2
3
4


    /** @var int 合同类型-电子 */
    const CONTRACT_TYPE_ELECTRONIC = 0;
    /** @var int 合同类型-纸质 */
    const CONTRACT_TYPE_PAPER = 1