美文网首页我爱编程
php代码注释规范

php代码注释规范

作者: f09037cb27f7 | 来源:发表于2018-04-16 15:43 被阅读67次

注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。

php里面常见的几种注释方式:

1.文件头的注释,介绍文件名,功能以及作者版本号等信息

/** 
*文件名简单介绍
* 
*文件功能。 
* @author      alvin 作者
* @version     1.0 版本号
*/ 

2.函数的注释,函数作用,参数介绍及返回类型

/**  
* 函数的含义说明 
* 
* @access public 
* @param mixed $arg1 参数一的说明 
* @param mixed $arg2 参数二的说明 
* @param mixed $mixed 这是一个混合类型 
* @return array 返回类型
*/  

3.类的注释,类名及介绍

/** 
* 类的介绍 
* 
* 类的详细介绍(可选。)。 
* @author      alvin 作者 
* @version     1.0 版本号
*/ 

4.多行注释

/* php注释语法
   这是多行注释。*/ 

5.单行注释

$n = 10; //数量n,这是单行注释

相关文章

  • php代码注释规范

    注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 php里面常...

  • PHP语法

    PHP文件拓展名为.php 代码块: 每行代码以 ; 结尾

  • 初识PHP的重点一

    语法规范文档中只有php代码,结束标记要省略掉 注释单行:# 或者 //多行:/* 代码 */ 变量:普通变量...

  • iOS 注释

    1、规范的注释让代码更好看 2、规范的注释让代码更实用 注释(单行注释) /* <##> */ 注释(预编译注释...

  • PHP开发规范——代码规范篇(三):注释规范

    在代码中添加合适的注释来注解代码可以代码的可读性,可以使得自己和团队其他成员在之后的代码的审查和维护中更加省时省力...

  • PHP注释规范

    注释语法 PHP注释有三种语法: 使用规范 很多教程里只会告诉我们怎么写就是注释,这样就不会被解释器解释运行,但是...

  • php注释规范

    注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 1 文件头的...

  • Java语言基础

    注释与规范 代码注释 单行注释:// 多行注释:/**/ 文档注释:/** */ 编码规范 可读性第一,效率第二 ...

  • PHP学习笔记一(菜鸟教程)

    2016/10/24 1.php代码放在 2.PHP变量 ...

  • 小肤iOS开发代码规范_v1.0

    For Objective-C , 2018.8.2 Ⅰ.前言Ⅱ.命名规范Ⅲ.代码注释规范Ⅳ.代码格式化规范Ⅴ....

网友评论

    本文标题:php代码注释规范

    本文链接:https://www.haomeiwen.com/subject/cjjekftx.html