Les commentaires ne peuvent pas être négligents car ils veulent expliquer les raisons de l'existence du code plut?t que des fonctions, telles que la compatibilité avec les anciennes interfaces ou les restrictions tierces, sinon les personnes qui lisent le code ne peuvent s'appuyer que sur de la devinettes. Les zones qui doivent être commentées comprennent des jugements conditionnels complexes, une logique spéciale de gestion des erreurs et des restrictions de dérivation temporaires. Une fa?on plus pratique d'écrire des commentaires consiste à sélectionner des commentaires en une seule ligne ou à bloquer les commentaires en fonction de la scène. Utilisez des commentaires sur le bloc de documents pour expliquer les paramètres et les valeurs de retour au début des fonctions, des classes et des fichiers, et gardez les commentaires à jour. Pour une logique complexe, vous pouvez ajouter une ligne à la précédente pour résumer l'intention globale. En même temps, n'utilisez pas de commentaires pour sceller le code, mais utilisez des outils de contr?le de version.
La rédaction de commentaires PHP est en fait assez importante, mais beaucoup de gens ne le font pas correctement. Les commentaires ne sont pas seulement écrits quelques phrases. La clé est d'aider les autres (ou vous-même à l'avenir) à comprendre le code plus rapidement.

Pourquoi les commentaires ne peuvent-ils pas être baclés?
Lorsque de nombreux novices écrivent des commentaires, ils aiment écrire du contenu ambigu comme "cette fonction fait quelque chose", ce qui équivaut en fait à ne pas l'écrire. Un bon commentaire devrait expliquer pourquoi ce code existe, pas ce qu'il fait . Par exemple:
- Cette logique est pour la compatibilité avec les anciennes versions d'interfaces
- Un certain paramètre doit être géré spécifiquement en raison des limites des bibliothèques tierces
Si ces informations ne sont pas écrites, les personnes qui lisent le code ne peuvent que deviner.

Où dois-je ajouter des commentaires?
Certains blocs de code sont recommandés pour ajouter des commentaires même s'ils semblent très clairs, tels que:
- Jugement conditionnel complexe, surtout lors de la nidification de multicouches
- Logique spéciale de gestion des erreurs
- Limites qui doivent être temporairement contournées (par exemple, un patch est appliqué)
Par exemple, si vous avez un morceau de code qui traite la conversion de format de temps, le simple fait de regarder le code peut savoir qu'il convertit les formats, mais je ne sais pas pourquoi vous devez utiliser strtotime()
au lieu d'un objet directement DateTime. Pour le moment, un commentaire peut économiser beaucoup de doutes.

Comment rédiger des commentaires plus pratiques?
Il existe deux méthodes d'annotation couramment utilisées dans PHP: commentaire à une seule ligne //
et commentaire de bloc /* */
. Sélection recommandée basée sur la scène:
- Utilisez une brève description
//
- Les fonctions, les classes et les fichiers sont commentés avec des blocs de documents au début, tels que:
/ ** * Traiter la logique de connexion de l'utilisateur, y compris le processus de vérification tiers * * @param string $ nom d'utilisateur nom d'utilisateur * @param string $ mot de passe mot de passe * @return bool ligin est réussi * /
Quelques autres conseils:
- N'utilisez pas de commentaires pour "sceller" les gros morceaux de code, utilisez plut?t des outils de contr?le de version
- Gardez les commentaires à jour, ne laissez pas les vieux commentaires en erreur
- Si la logique est compliquée, vous pouvez ajouter une ligne de commentaires pour résumer l'intention globale
Dernier point: n'ayez pas peur d'écrire quelques phrases supplémentaires
Parfois, vous penserez: "Ce code n'est-il pas évident?" Mais quand vous revenez le voir dans quelques mois, vous devrez peut-être y penser pendant longtemps. Au lieu de le regretter par la suite, il est préférable de passer quelques secondes de plus à l'écrire. Surtout pour certains "points de stand" ou "pratiques non standard", même si vous écrivez une ou deux phrases supplémentaires, cela sera très utile aux générations ultérieures.
Fondamentalement, c'est tout. Les commentaires semblent petits, mais c'est vraiment un gaspillage de choses si vous ne pouvez pas bien le faire.
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!

Outils d'IA chauds

Undress AI Tool
Images de déshabillage gratuites

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.

Clothoff.io
Dissolvant de vêtements AI

Video Face Swap
échangez les visages dans n'importe quelle vidéo sans effort grace à notre outil d'échange de visage AI entièrement gratuit?!

Article chaud

Outils chauds

Bloc-notes++7.3.1
éditeur de code facile à utiliser et gratuit

SublimeText3 version chinoise
Version chinoise, très simple à utiliser

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

Dreamweaver CS6
Outils de développement Web visuel

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

Pour gérer correctement les transactions JDBC, vous devez d'abord désactiver le mode de validation automatique, puis effectuer plusieurs opérations, et enfin vous engager ou randonner en fonction des résultats; 1. Appelez Conn.SetAutoCommit (false) pour démarrer la transaction; 2. Exécuter plusieurs opérations SQL, telles que l'insertion et la mise à jour; 3. Appelez Conn.Commit () Si toutes les opérations sont réussies, et appelez Conn.Rollback () Si une exception se produit pour garantir la cohérence des données; Dans le même temps, les ressources TRY-With doivent être utilisées pour gérer les ressources, gérer correctement les exceptions et cl?turer les connexions pour éviter la fuite de connexion; De plus, il est recommandé d'utiliser des pools de connexion et de définir des points de sauvegarde pour réaliser un retour en arrière partiel, et de maintenir les transactions aussi courtes que possible pour améliorer les performances.

Utilisez des classes dans le package Java.Time pour remplacer les anciennes classes de date et de calendrier; 2. Obtenez la date et l'heure actuelles via LocalDate, LocalDateTime et Localtime; 3. Créez une date et une heure spécifiques en utilisant la méthode OF (); 4. Utilisez la méthode plus / moins pour augmenter et diminuer le temps; 5. Utilisez ZonedDateTime et ZoneID pour traiter le fuseau horaire; 6. Format et cha?nes de date d'analyse via DateTimeFormatter; 7. Utilisez instantanément pour être compatible avec les anciens types de dates si nécessaire; Le traitement des dattes dans le Java moderne devrait donner la priorité à l'utilisation de Java.timeapi, qui fournit clairement, immuable et linéaire

Pré-formancetartuptimemoryusage, quarkusandmicronautleadduetocompile-timeprocessingandgraalvsupport, withquarkusofperforming lightbetterine scénarios.

La collecte des ordures de Java (GC) est un mécanisme qui gère automatiquement la mémoire, ce qui réduit le risque de fuite de mémoire en récupérant des objets inaccessibles. 1. GC juge l'accessibilité de l'objet de l'objet racine (tel que les variables de pile, les threads actifs, les champs statiques, etc.), et les objets inaccessibles sont marqués comme des ordures. 2. Sur la base de l'algorithme de compensation de marque, marquez tous les objets accessibles et effacez des objets non marqués. 3. Adopter une stratégie de collecte générationnelle: la nouvelle génération (Eden, S0, S1) exécute fréquemment MinorGC; Les personnes agées fonctionnent moins, mais prend plus de temps pour effectuer MajorGC; Metaspace Stores Metadata de classe. 4. JVM fournit une variété de périphériques GC: SerialGC convient aux petites applications; Le parallelGC améliore le débit; CMS réduit

Le choix du bon type HTMLinput peut améliorer la précision des données, améliorer l'expérience utilisateur et améliorer la convivialité. 1. Sélectionnez les types d'entrée correspondants en fonction du type de données, tels que le texte, le courrier électronique, le tel, le numéro et la date, qui peuvent vérifier automatiquement la somme de la somme et l'adaptation au clavier; 2. Utilisez HTML5 pour ajouter de nouveaux types tels que l'URL, la couleur, la plage et la recherche, qui peuvent fournir une méthode d'interaction plus intuitive; 3. Utilisez l'espace réservé et les attributs requis pour améliorer l'efficacité et la précision du remplissage des formulaires, mais il convient de noter que l'espace réservé ne peut pas remplacer l'étiquette.

GradleisthebetterChoiceFormostNewProjectsDuetOtsSuperiorflexibility, Performance et ModerNtoolingSupport.1.gradle’sgroovy / kotlindslismoreConcis

Le report est utilisé pour effectuer des opérations spécifiées avant le retour de la fonction, telles que les ressources de nettoyage; Les paramètres sont évalués immédiatement lorsqu'ils sont reportés et les fonctions sont exécutées dans l'ordre de la dernière entrée (LIFO); 1. Plusieurs éleveurs sont exécutés dans l'ordre inverse des déclarations; 2. Communément utilisé pour le nettoyage sécurisé tel que la fermeture des fichiers; 3. La valeur de retour nommée peut être modifiée; 4. Il sera exécuté même si la panique se produit, adaptée à la récupération; 5. éviter l'abus de report dans les boucles pour éviter la fuite des ressources; Une utilisation correcte peut améliorer la sécurité et la lisibilité du code.

HTTP Log Middleware dans GO peut enregistrer les méthodes de demande, les chemins de requête, la propriété intellectuelle du client et le temps qui prend du temps. 1. Utilisez http.handlerfunc pour envelopper le processeur, 2. Enregistrez l'heure de début et l'heure de fin avant et après l'appel Suivant.Servehttp, 3. Obtenez le vrai client IP via R.RemoteAddr et X-Forwared-For Headers, 4. Utilisez le log.printf aux journaux de demande de sortie, 5. L'exemple de code complet a été vérifié pour s'exécuter et convient au démarrage d'un projet petit et moyen. Les suggestions d'extension incluent la capture des codes d'état, la prise en charge des journaux JSON et le suivi des ID de demande.
