Les commentaires sont très importants dans le processus d'écriture de code. De bons commentaires peuvent rendre votre code plus facile à lire. Lors de l'écriture de code, vous devez faire attention aux spécifications des commentaires. Ici, l'éditeur de Script House le triera pour vous. Les amis dans le besoin peuvent s'y référer.
Spécification des commentaires HP
Les commentaires sont très importants dans le processus d'écriture de code. De bons commentaires peuvent rendre votre code plus facile à lire lors de l'écriture. code, veillez à faire attention à la spécification des commentaires.
« PHP est un langage extrêmement simple avec lequel débuter. Un novice qui vient de commencer pourra peut-être utiliser echo pour imprimer un bonjour tout le monde en moins de quelques minutes ! Comment faire ? Qu'en est-il de la définition d'un programmeur ? Si vous voulez vraiment devenir un programmeur, vous devez suivre un ensemble de normes d'écriture de programmes "
Nous écrivons souvent certaines fonctions, mais ces fonctions peuvent seulement être comprises. par nous-mêmes, et même Cela fait un moment que je n'ai pas reconnu ce que j'ai écrit, alors que dois-je faire ? Le meilleur moyen est bien sûr d’ajouter des commentaires à votre code.
Nous connaissons peut-être de nombreuses façons d'écrire des commentaires, des commentaires C pear PHP, etc., mais les principales que nous utilisons sont # et /**/.
# est une méthode de commentaire court. Peut-être que vous l'utiliserez pour annoter une variable ou appeler une méthode. /**/. Nous pouvons toujours l'utiliser pour commenter. une grande section de code, mais comment l'utiliser pour annoter une fonction de manière standard ?
/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数作者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息 * @example 示例 * @exclude 指明当前的注释将不进行分析,不出现在文挡中 * @final 指明这是一个最终的类、方法、属性,禁止派生、修改。 * @global 指明在此函数中引用的全局变量 * @include 指明包含的文件的信息 * @link 定义在线连接 * @module 定义归属的模块信息 * @modulegroup 定义归属的模块组 * @package 定义归属的包的信息 * @param 定义函数或者方法的参数信息 * @return 定义函数或者方法的返回信息 * @see 定义需要参考的函数、变量,并加入相应的超级连接。 * @since 指明该api函数或者方法是从哪个版本开始引入的 * @static 指明变量、类、函数是静态的。 * @throws 指明此函数可能抛出的错误异常,极其发生的情况 * @todo 指明应该改进或没有实现的地方 * @var 定义说明变量/属性。 * @version 定义版本信息 */
Les informations contenues dans les annotations sont très complètes. Il peut y avoir beaucoup d'informations que nous n'utilisons pas. Les parties rouges sont celles que nous utilisons souvent.
Exemple : Plusieurs méthodes de commentaires courantes en php :
1. Commentaires sur le fichier, introduisant le nom du fichier, la fonction, le numéro de version de l'auteur et d'autres informations
/** * 文件名简单介绍 * * 文件功能 * @author 作者 * @version 版本号 * @date 2020-02-02 */
Modèle d'en-tête de fichier
/** *这是一个什么文件 * *此文件程序用来做什么的(详细说明,可选。)。 * @author richard<e421083458@163.com> * @version $Id$ * @since 1.0 */
2. Commentaires de classe, nom de classe et introduction
/** * 类的介绍 * * 类的详细介绍(可选) * @author 作者 * @version 版本号 * @date 2020-02-02 */
/** * 类的介绍 * * 类的详细介绍(可选。)。 * @author richard<e421083458@163.com> * @since 1.0 */ class Test { }
3. Commentaires de fonction, fonction, introduction de paramètre et type de retour
/** * 函数的含义说明 * * @access public * @author 作者 * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @return array 返回类型 * @date 2020-02-02 */
Commentaires d'en-tête de fonction
/** * some_func * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */ public function thisIsFunction($string, $integer, $mixed) {return array();}
Commentaires sur le code du programme
1 Le principe des commentaires est de poser le problème Expliquez. il est clair que plus n’est pas toujours mieux.
2. Plusieurs instructions sont utilisées comme bloc de code logique, et les commentaires de ce bloc peuvent être /* */.
3. Pour les commentaires spécifiques à une certaine déclaration, vous pouvez utiliser des commentaires de fin de ligne : //.
/* 生成配置文件、数据文件。*/ $this->setConfig(); $this->createConfigFile(); //创建配置文件 $this->clearCache(); // 清除缓存文件 $this->createDataFiles(); // 生成数据文件 $this->prepareProxys(); $this->restart();
Convention de dénomination PHP
1. Répertoires et fichiers
Utiliser des lettres minuscules. pour les répertoires + soulignement
Bibliothèque de classes, les fichiers de fonctions sont uniformément suffixés par .php
Les noms de fichiers de classe sont définis dans les espaces de noms, et le chemin de l'espace de noms est cohérent avec le chemin du fichier de bibliothèque de classes
Fichiers de classe sont nommés en majuscule (la première lettre est en majuscule), les autres fichiers sont nommés en minuscules + souligné
Le nom de la classe et le nom du fichier de classe sont cohérents et la méthode de la casse en chameau est uniformément utilisée (la première lettre est en majuscule)
2. Fonctions et classes, dénomination des attributs
Les classes sont nommées en utilisant la casse camel (la première lettre est en majuscule), comme User, UserType Par défaut, aucun suffixe n'est requis. Par exemple, UserController doit être directement nommé User
Les fonctions sont nommées en utilisant des lettres minuscules et des traits de soulignement (commençant par une lettre minuscule). Par exemple, le nom de la méthode get_client_ip
utilise la casse camel (la première lettre est en minuscule), comme getUserName (si la méthode a une valeur de retour, il est actuellement d'usage d'utiliser la première lettre en minuscule pour le type d'attribut, comme s(string), i(int ), f (float), b (boolean), a (tableau), etc.)
La dénomination des attributs utilise la casse chameau (la première lettre est minuscule), comme tableName, instance (il est actuellement d'usage d'utiliser des minuscules pour la première lettre des types d'attributs, comme s (string), i (int), f (float), b (boolean), a (array), etc.)
Les fonctions ou méthodes commençant par un double trait de soulignement "__" sont utilisées comme méthodes magiques, telles que __call et _ _autoload
3. Constantes et configurations
Les constantes sont nommées avec des lettres majuscules et des traits de soulignement, tels que APP_PATH et THINK_PATH
Les paramètres de configuration sont nommés avec des lettres minuscules et des traits de soulignement, tels que url_route_on et url_convert
4. Champs de la zone de table de données
Les tables et champs de données sont nommés en minuscules et soulignés, et veillez à ne pas commencer le nom du champ par un trait de soulignement, comme think_user table et user_name field. . Il n'est pas recommandé d'utiliser la casse camel et le chinois pour la dénomination des champs.

PHP注释大揭秘:单行注释和多行注释详细对比PHP是一种广泛应用的网页开发语言,其中注释的使用对于代码的可读性和维护性起着至关重要的作用。在PHP中,常见的注释有单行注释和多行注释两种形式。本文将详细对比这两种注释形式,并提供具体的代码示例,帮助读者更好地理解它们的用法和差异。一、单行注释单行注释是在代码中添加一行注释,以//开头,直到行尾为止。单行注释

php注释的种类有单行注释、多行注释、文档注释和条件注释等。详细介绍:1、单行注释以双斜杠“//”开头,用于注释单行代码,在这种注释类型中,从双斜杠开始到该行末尾的所有内容都将被视为注释,不会被解释为代码;2、多行注释以斜杠星号“/”开头,以星号斜杠“*/”结尾,这种注释类型可用于注释一段代码或多行代码;3、文档注释也以斜杠星号“/”开头,以星号斜杠“*/”结尾等等。

代码注释是程序员在编写代码时添加的文本提醒,以便自己和其他程序员更轻松地阅读和理解代码。在PHP中,代码注释是不可或缺的。本文将详细介绍PHP中的代码注释的类型、规范和用途。一、PHP中的代码注释类型在PHP中,有三种类型的注释:单行注释、多行注释和文档注释。单行注释单行注释以双斜线“//”开始,直到行尾结束。例如://这是一个单行注释多行注释多行注释以“

进入PHP编程领域,注释是一个非常重要的概念。在编写代码时,注释对于阐述代码意图、帮助其他开发者理解代码逻辑以及方便自己日后维护代码都是至关重要的。在PHP中,注释分为单行注释和多行注释两种,在使用上有一些区别。本文将深入探讨PHP注释的特点以及单行注释和多行注释的使用方式,并通过具体的代码示例进行说明。1.单行注释单行注释是在代码中添加一行注释,用来解释

php的注释种类有:1、单行注释,用于解释某个功能、提醒其他开发者或自己注意点等;2、多行注释,用于对多行代码块进行详细的说明;3、文档注释,用于对整个代码块或函数、方法进行详细的说明。

PHP注释规范:如何使用文档注释编写API文档引言:在开发PHP应用程序时,编写完善的API文档对于开发团队和其他开发者来说非常重要。好的文档可以提高代码的可读性和可维护性,并促进团队合作与信息共享。本文将介绍如何使用文档注释编写PHP的API文档,并提供一些示例代码帮助读者理解如何规范地编写注释。注释规范在PHP中,我们使用注释来对代码进行说明和描述。一般

如何在PHP中使用注释来增强代码可读性和理解性引言:在开发过程中,注释是一个非常重要的组成部分,可以帮助开发者更好地理解代码,提高代码的可读性和维护性。本文将介绍在PHP中如何使用注释来增强代码的可读性和理解性,并提供一些实际的代码示例。单行注释单行注释是用来对代码的某一行进行解释和说明。在PHP中,单行注释以双斜杠(//)开头,直到行尾结束。下面是一个示例

PHP是一种流行的服务器端脚本语言,广泛应用于Web开发领域。在代码编写过程中,注释是一个非常重要的元素,可以帮助开发者更好地理解代码,提高代码的可读性和可维护性。本文将详细介绍PHP中的注释类型,包括单行注释与多行注释,同时提供具体的代码示例。单行注释在PHP中,使用双斜杠//可以实现单行注释。单行注释从//开始一直到该行的末尾。单行注释通常用于对代码进行


Outils d'IA chauds

Undresser.AI Undress
Application basée sur l'IA pour créer des photos de nu réalistes

AI Clothes Remover
Outil d'IA en ligne pour supprimer les vêtements des photos.

Undress AI Tool
Images de déshabillage gratuites

Clothoff.io
Dissolvant de vêtements AI

AI Hentai Generator
Générez AI Hentai gratuitement.

Article chaud

Outils chauds

Envoyer Studio 13.0.1
Puissant environnement de développement intégré PHP

Télécharger la version Mac de l'éditeur Atom
L'éditeur open source le plus populaire

ZendStudio 13.5.1 Mac
Puissant environnement de développement intégré PHP

SublimeText3 version Mac
Logiciel d'édition de code au niveau de Dieu (SublimeText3)

Dreamweaver Mac
Outils de développement Web visuel
