数码资讯
PHP代码规范的注释和文件结构描述
选购提示
关注价格、性能、续航、售后和真实使用场景,理性比较后再下单。
文件结构
| --图像
| --包括
|参数
|配置
|功能
|指数
图像存储的图像文件,包括系统是参考文件,一般参数存储在参数文件,配置文件,函数文件存储方法,如javascript的方法,并根据分类的功能模块,功能的类到其中。
文件名
该文件夹的名称一般是英文的,长度一般不超过20个字符,并且名称是小写的。除了在特殊情况下使用汉语拼音,一些常用的文件夹名称,如:图像(图形文件存储)、闪存(存储文件),风格(存储的CSS文件,脚本)(公司、Javascript脚本)(存储包含文件),链接(友情链接)、媒体(存储的多媒体文件)等。该文件的名称是统一在一个英文字母,数字和下划线的小案例。
块注释
块注释通常用于说明文件、方法、数据结构和算法,块注释放在每个文件的开始,在每个方法。也可以用在其他地方,如内部方法,块注释的功能和方法应该有相同的缩进格式他们描述的代码。
块注释的头应该有一个空行来从代码中分割块注释,例如:
*
*这里是块注释
* /
块注释以开头,所以缩进(1)识别可以是一段代码,而不用重排它。
—
*如果您希望被忽略,但使用特殊格式的块注释
*
*一
*两
*三
* /
注意:如果您不使用缩进(1),则不需要使用代码,也可以不使用缩进代码(1)。
单行注释
短注释可以显示在一行中,并具有与后面代码相同的缩进级别。如果注释不能在一行完成,则应使用块注释。在单行注释之前应该有空行。下面是代码中单行注释的示例:
如果(条件){
以下代码操作条件
…
}
尾端注释
非常短的注释可以与他们想描述的代码保持一致,但是应该有足够的空格来分隔代码和注释。如果在大段代码中出现多个短音符,它们应该具有相同的缩进。
下面是代码尾部注释的一个示例:
复制代码代码如下所示:
如果($ = 2){
返回true;仅在一个条件下返回。
{ { { }
返回isPrime(美元); / * * /休息条件
}
行结束注释
注释分隔符一般不用于连续多行注释文本;但是,它可以用来注释连续的代码行数。以下是所有三种类型的示例:
复制代码代码如下所示:
如果($ > 1){
第二次使用。
…
}
{其他
返回false;
}
如果($ bar > 1){
第三。
…
/
| --图像
| --包括
|参数
|配置
|功能
|指数
图像存储的图像文件,包括系统是参考文件,一般参数存储在参数文件,配置文件,函数文件存储方法,如javascript的方法,并根据分类的功能模块,功能的类到其中。
文件名
该文件夹的名称一般是英文的,长度一般不超过20个字符,并且名称是小写的。除了在特殊情况下使用汉语拼音,一些常用的文件夹名称,如:图像(图形文件存储)、闪存(存储文件),风格(存储的CSS文件,脚本)(公司、Javascript脚本)(存储包含文件),链接(友情链接)、媒体(存储的多媒体文件)等。该文件的名称是统一在一个英文字母,数字和下划线的小案例。
块注释
块注释通常用于说明文件、方法、数据结构和算法,块注释放在每个文件的开始,在每个方法。也可以用在其他地方,如内部方法,块注释的功能和方法应该有相同的缩进格式他们描述的代码。
块注释的头应该有一个空行来从代码中分割块注释,例如:
*
*这里是块注释
* /
块注释以开头,所以缩进(1)识别可以是一段代码,而不用重排它。
—
*如果您希望被忽略,但使用特殊格式的块注释
*
*一
*两
*三
* /
注意:如果您不使用缩进(1),则不需要使用代码,也可以不使用缩进代码(1)。
单行注释
短注释可以显示在一行中,并具有与后面代码相同的缩进级别。如果注释不能在一行完成,则应使用块注释。在单行注释之前应该有空行。下面是代码中单行注释的示例:
如果(条件){
以下代码操作条件
…
}
尾端注释
非常短的注释可以与他们想描述的代码保持一致,但是应该有足够的空格来分隔代码和注释。如果在大段代码中出现多个短音符,它们应该具有相同的缩进。
下面是代码尾部注释的一个示例:
复制代码代码如下所示:
如果($ = 2){
返回true;仅在一个条件下返回。
{ { { }
返回isPrime(美元); / * * /休息条件
}
行结束注释
注释分隔符一般不用于连续多行注释文本;但是,它可以用来注释连续的代码行数。以下是所有三种类型的示例:
复制代码代码如下所示:
如果($ > 1){
第二次使用。
…
}
{其他
返回false;
}
如果($ bar > 1){
第三。
…
/
声明:本文内容用于数码产品信息整理与选购参考,具体价格、库存、售后政策以官方渠道和电商页面实时信息为准。