[RUBY] Considérer la dénomination de code d'un point de vue littéraire

introduction

Il est écrit comme un résumé de l'expérience des conventions de code lors de l'écriture en Ruby.

Définition de code facile à lire

Vous devez écrire votre code dans le but de pouvoir terminer la lecture du code dans les plus brefs délais afin que le lecteur puisse apporter des modifications et trouver des bogues.

Ce que vous pouvez comprendre lorsque vous traduisez ce que contrôlent les variables, méthodes et classes

Comme amélioration superficielle, considérez la facilité de comprendre ce qui peut être écrit arbitrairement

Les variables, les méthodes, les classes et les parties de ces codes qui peuvent être écrites et définies presque arbitrairement doivent être soigneusement écrites pour effacer les définitions de code ci-dessus. Pour être honnête, même si je l'ai écrit intentionnellement, cela peut être trompeur. C'est ennuyeux parce qu'il semble que je ne pense à rien à moins que j'élimine autant que possible la possibilité de mal lire.

Utilisez des mots clairs

Utilisez des verbes simples, une nomenclature, des adjectifs et des préfixes. Lors de l'utilisation de mots anglais, il n'est pas nécessaire d'écrire selon la grammaire anglaise du ticking, mais cela peut plutôt prêter à confusion, il est donc également possible de juger la situation pour qu'elle soit en règle générale convaincante au sein du produit ou de l'équipe. Vous en aurez besoin. Par exemple, de. Il existe également un moyen de traduire A de B en B de A au lieu de A seul de B. Même si celui que vous utilisez n'a pas d'importance, vous serez averti si de nombreuses personnes connaissent A dans B.

Dans les expressions verbales, la grammaire est souvent ignorée dans le sens de l'emphase, et c'est un fait que même les étrangers n'expriment pas avec autant de soin, mais en codant, écrivent des contrats à l'étranger. Il semble que vous deviez être aussi intelligent que d'écrire un document officiel dans ce domaine.

Peut-être que s'il y a un mot qui est célèbre pour être utilisé comme nom mais qui peut également être utilisé comme adjectif, ce sera une cible d'avertissement s'il est utilisé. Par exemple, le coût du produit. Le fait est qu'il repose sur de grandes choses empiriques, familières ou inconnues.

Les verbes des parties passées sont également confondus avec les verbes du passé et doivent être évités. Les mots participatifs gênants dans la lecture d'une phrase doivent également être jugés en fonction du contexte et doivent être évités en tant qu'expressions. Il semble préférable de ne pas utiliser de grammaires qui nécessitent un jugement contextuel. En raison de la nature de cette syntaxe, les synonymes relationnels sont des grammaires grammaticalement longues et ne seront pas utilisés. Cependant, bien qu'il existe de nombreuses façons de juger lorsque chaque grammaire se chevauche, il semble nécessaire d'éviter toutes les expressions qui sont laissées au contexte dans le codage qui nécessite des expressions qui nécessitent des informations à insérer aussi courtes que possible.

Il n'y a pas beaucoup de grammaires à connaître

――Lorsque vous utilisez des verbes, vous devez être conscient des cinq modèles de phrases, donc soyez conscient de l'utilisation appropriée des verbes automatiques et autres. --Multiple et singulier

Jusqu'à présent, c'est tout ce qui m'importe.

Pas besoin de mots explicites

Par exemple, le nom de variable utilisateur enregistré peut être user. En effet, il est clair qu'ils sont enregistrés lorsqu'ils entrent dans la base de données.

Évitez les noms génériques et donnez des noms spécifiques

La création d'une variable avec un seul nez peut être trompeuse pour le lecteur à mesure que le code se développe. Par exemple, s'il y a des variables qui ne contiennent que des données ici et là, elles seront difficiles à lire.

Évitez les abréviations

C'est convaincant. Je ne sais pas si get_user_data est gud ou quelque chose comme ça ...

La méthode utilise le verbe

C'est le code qui effectue le traitement, il est donc préférable d'utiliser des verbes.

Les noms de classe et les variables utilisent la nomenclature

Soyez conscient de ce que la classe contrôle et dans quoi les variables sont stockées

N'utilisez pas de paraphrases

Le code n'est pas une phrase, il vaut donc mieux ne pas le paraphraser. J'ai tendance à le faire comme si j'écrivais une phrase. N'utilisez pas des choses qui ont presque la même signification, comme Memmber = user, mais unifiez les choses qui ont la même signification avec le même mot.

Notation obsolète

La notation hongroise, une méthode de dénomination qui insère des informations telles que les types et les portées dans les noms de variables et les noms de classes, est actuellement obsolète et semble être un anti-modèle dans de nombreux cas. Par exemple, dans le cas d'un tableau, évitez d'en faire une variable telle que arr_data.

Recommended Posts

Considérer la dénomination de code d'un point de vue littéraire
Réétudier Docker du point de vue du fonctionnement du système