Routine pour garder les noms des méthodes, classes et fonctions organisés?

Question

Je travaille sur une application web avec quelques collègues pour le moment. Il s'est avéré que nous avons tous notre propre façon de nommer les classes, les méthodes ou les fonctions que nous sommes en train d'écrire.

Cela commence déjà à devenir très ennuyeux, alors je sais que nous avons un iceberg si nous continuons comme ça.

De toute évidence, le meilleur moyen est de trouver une routine et de s'y tenir - mais à quoi devrait ressembler cette routine particulière? - Qu'est-ce que le bon sens lorsque vous nommez des pièces, des objets, des fonctions ou quoi que ce soit? Y a-t-il des normes là-bas?

Merci beaucoup!

Answer 1

Vous pouvez jeter un oeil à l'adresse suivante: http://www.dagbladet.no/development/phpcodingstandard/

Mon travail a mis en œuvre cela, et pendant que je fais toujours pas d'accord, au moins il génère la cohérence .

Answer 2

Utilisez les espaces de noms. Réunissez-vous et proposez une stratégie de hiérarchie d'espace de noms logique, puis utilisez des noms logiques dans les espaces de noms pour les éléments.

Answer 3

Une norme que vous pourriez adopter est le Zend Framework standards

Answer 4

Asseyez-vous avec vos collègues, expliquez le problème que vous observez, puis écrivez une norme sur laquelle vous êtes tous d'accord.

Comme vous l'avez identifié, le seul problème est la cohérence. Par conséquent, ne vous convainquez pas que vous avez également besoin d'une norme scientifiquement prouvée comme optimale.

Answer 5

Jetez un oeil à la PEAR Coding Standards. C'est assez complet et rendrait les choses plus faciles si jamais vous utilisiez des paquets de poires.

Il peut également être utile de rechercher CRUD (Create Read Update Delete) sur Wikipedia. En ce qui concerne les singuliers et les pluriels, j'ai tendance à essayer de m'en tenir au style conceptuel de mon code. Je trouve qu'avec la POO, les noms d'objets ont généralement tendance à être plus faciles à comprendre lorsque vous utilisez des singuliers.

Même si votre classe comprend des informations sur plusieurs chiens, au lieu de les nommer Dogs, nommez-la autrement, comme Pack, même si techniquement ce n'est pas un pack. Il est plus facile d'envelopper votre esprit autour de plusieurs Packs que de plusieurs Dogs, et un "pack" est conceptuellement plus fort qu'un groupe de "chiens" amorphe. "Dogs" ne sonne pas comme un objet unique, alors que "pack" le fait.

Je suppose que c'est un exemple évident, mais si votre classe ne va être utilisée que pour définir des objets sur une base individuelle, ne le faites pas au pluriel. Ou si votre fonction ne formate qu'une chaîne à la fois, ne l'appelez pas formatStrings().

Les tableaux sont un peu différents. Si vous utilisez un tableau pour une liste de tous vos chiens, vous ne le nommez pas $ pack, car vous vous attendez à ce qu'il contienne des informations sur un pack. Au lieu de cela, vous l'appelez $ dogs.