Comment écrire du beau code PHP

Une bonne habitude de codage se développe grâce à des habitudes quotidiennes. Si l'équipe a de bonnes normes de codage et que tout le monde suit les normes de codage établies, alors je pense que la qualité et la maintenabilité du code atteindront un niveau supérieur. À l'heure actuelle, PHP doit se conformer aux normes PSR. Je vais seulement énumérer quelques méthodes d'écriture couramment utilisées dans le codage pour expliquer. Pour plus de spécifications, vous pouvez rechercher les normes PSR.

Balise de début de fichier PHP

Pour les fichiers de code PHP pur, ils doivent commencer par des balises 2339c4ba529384d216e4ea9b05a790d1 . Quant à savoir pourquoi, je pense que si vous êtes intéressé, vous pouvez le découvrir par vous-même.

<?php

class TestDemo
{
}

Déclaration de la classe Class

Le nom de la classe doit être nommé en casse chameau (TestDemo) en commençant par une majuscule. Les deux accolades sont enveloppées et occupent une ligne exclusive. requis pour décrire le créateur et la fonction de la classe, etc.

/**
 * 这是一个测试Demo类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

Constantes de la classe Class

Les constantes de la classe doivent être nommées en lettres majuscules (HELLO_WORLD), et les mots sont séparés par des traits de soulignement _, et il est préférable d'ajouter des commentaires. Il est préférable d'en ajouter un seul. -line comment after // Laisse un espace suivi d'un commentaire.

// 声明一个常量
const HELLO_WORLD = 'best';

Attributs membres de la classe Class

Attributs membres (également appelés variables membres) dans la classe La dénomination des attributs membres peut suivre trois règles : la casse camel commençant par une majuscule ($UserName), la casse camel commençant par une minuscule ($. userName ), délimité par des traits de soulignement ($user_name) ; les trois règles de dénomination sont acceptables. Personnellement, j'ai l'habitude d'utiliser des traits de soulignement. Vous pouvez également choisir en fonction de vos propres habitudes, mais il est préférable d'être cohérent avec le codage de l'équipe. règles Dans le même temps, les trois modificateurs de règles de dénomination (public, protégé, privé) ne peuvent pas manquer.

// 声明一个公共变量
public $user_name = '';
// 声明一个静态变量
public static $user_age = 18;

Méthodes membres de la classe Class

La dénomination des méthodes membres de la classe doit adopter la règle de dénomination camel (testAction) commençant par minuscule. Les trois modificateurs de la méthode (public, protégé, privé) ne peuvent pas manquer. , et il y a deux accolades. Enroulez-le dans une nouvelle ligne et occupez sa propre ligne. Il devrait y avoir un espace des deux côtés du signe égal du paramètre. Ne manquez pas les commentaires sur la méthode, y compris la fonction de. la méthode, la description du paramètre, la description de la valeur de retour, etc.

/**
 * 这是一个测试方法
 * @param string $msg 参数说明
 * @return array
 */
public function testAction($msg = '')
{
    // 返回数据格式
    $return = array('code' => 200, 'msg' => '');
    return $return;
}

/**
 * 这是私有方法，方法命名以单下划线开始
 * @param string $arg 参数说明
 * @return string
 */
private function privateAction($arg = '')
{
    return $arg;
}

Opérateurs et expressions

Par rapport aux opérateurs ou aux différents types d'expressions, peu importe où ils sont utilisés, nous devons avoir un espace des deux côtés de leurs symboles, comme $a = 1;, 1 + 2 et 1 && 0 etc.

/**
 * 获取两个数相加的和
 * @param int $one 第一个数
 * @param int $two 第二个数
 * @return int
 */
public function getUserAge($one = 0, $two = 0)
{
    $sum = $one + $two;
    return $sum;
}

La manière standard d'écrire les structures de contrôle

est similaire à if...else, while, switch...case, foreach, for et d'autres structures de contrôle de processus. Fondamentalement, elles doivent être utilisées avec des parenthèses () et. les accolades {} et les parenthèses () sont obligatoires. Il y a un espace des deux côtés, et l'accolade gauche {doit être sur la même ligne que l'accolade droite) et a un espace, et l'accolade fermante droite} doit être sur une ligne distincte et le contenu principal est contenu entre accolades {}.

/**
 * 判断用户是否成年
 * @param int $age 年龄
 */
public function logicAction($age = 18)
{
    if ($age >= 18) {
        echo '已成年';
    } else {
        echo '未成年';
    }
}

Formatage rapide en un clic

De nombreux IDE prennent désormais en charge le formatage du code en un clic, comme PhpStorm, etc. Les touches de raccourci générales sont Ctrl + Alt + L. Vous pouvez également modifier les touches de raccourci et le code en fonction de votre propres habitudes Normes de format, vous pouvez formater l'intégralité du document en un seul clic, ou vous ne pouvez sélectionner qu'une certaine partie du code pour le formatage. PS : si ce fichier n'est pas créé et modifié par vous seul, veuillez ne pas formater facilement l'intégralité du fichier en un seul clic, car il formatera également le code d'autres personnes. Il est recommandé de formater uniquement votre propre code. d'autres peuvent jouer avec mon code à volonté, alors ne causez pas de problèmes ! Ne causez pas de problèmes ! Ne causez pas de problèmes ! Dites les choses importantes trois fois, vous savez.

Résumé final

Permettez-moi d'abord de vous donner quelques suggestions personnelles, j'espère qu'elles vous seront utiles :

• N'ajoutez pas d'espaces supplémentaires, c'est-à-dire ajoutez simplement un espace lorsque vous en avez besoin (suivez simplement les spécifications du code)

• Supprimez les sauts de ligne inutiles (affecte la beauté visuelle du code)

• N'oubliez pas de supprimer le code de débogage à temps, pas seulement les commentaires (j'ai peur que vous l'oubliiez avec le temps)

• Commentaires de code, commentaires de code, commentaires de code (Peu importe à quel point vous êtes occupé, vous devez écrire des commentaires appropriés, ne les ajoutez pas plus tard)

• Vous pouvez consulter le code des autres, mais ne modifiez pas les autres le code des gens à volonté (car les autres ne seront pas contents de regarder votre code)

Moi, je viens d'extraire une petite partie des spécifications de code couramment utilisées pour en parler. S'il y a quelque chose qui ne va pas dans l'écriture, veuillez le signaler. et je le modifierai à temps. Merci. Si vous possédez d’autres bonnes compétences en codage, n’hésitez pas à les partager avec tout le monde.

Apprentissage recommandé : Tutoriel vidéo php

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!