PHP, HTML, Javascript et écriture de bonnes pratiques

softwareengineering.stackexchange https://softwareengineering.stackexchange.com/questions/9584

Question

Je réalisé que je dois écrire une spécification de convention sur le langage HTML, JavaScript et PHP codant pour moi et mon équipe.

Dans le développement web, tout comme en C ++, je suis vraiment fan d'indentation et des commentaires.

Néanmoins, souvent dans mon travail, je rencontre HTML + JavaScript + le code PHP qui fait soudainement le mal de tête.

Je suis en train de faire mon code lisible, mais ce qui semble être mieux pour moi (à tiret et commentaire) ne semble pas fasciner mes coéquipiers, donc je me demandais s'il y a une meilleure ou du moins partagé les bonnes pratiques en rédaction de documents « hybrides », tout comme les pages web d'aujourd'hui, qui jour après jour de plus en plus complexe.

Je suis conscient du fait que, probablement, il est dans la nature du code de pages Web d'aujourd'hui d'être un peu intriqués, mais je me demande si une bonne convention concernant ces aspects existent déjà.

Était-ce utile?

La solution

Quelques règles générales I suivantes:

Général

  • Retraits sont 4 espaces.
  • de nouveaux niveaux Indente
  • Les commentaires sont <~ 80 caractères du niveau de retrait. Si je suis en deux niveaux (8 places) qui signifie l'arrêt du curseur sera d'environ 88 caractères.
  • Utilisez les commentaires multilignes. Je préfère le look, mais cela est un subjective point.
  • Commentaire maintenant plutôt que plus tard, quand vous ne savez pas ce qui se passe.
  • Allman . Il est plus propre et est plus facile à lire. Subjective .

JavaScript

  • Utilisez une bibliothèque. jQuery en particulier, est très bon. Il élimine tous les maux de tête de navigateur croix.
  • Comprendre que son ID sont des éléments particuliers, les classes sont des styles. ID de ne doit pas être utilisé plus d'une fois par page et ils auront des crochets particuliers qui leur sont rattachés. Utilisez des classes pour des choses comme la navigation.
  • Source Out dans les méthodes. Il est tentant de mettre tout le code dans l'appel bind, il mettre cependant dans sa propre fonction augmentera la flexibilité de votre code.
  • Utiliser les fonctions au lieu de evals. Cela signifie que setTimeout(function(){ /* Do something */ }, 1000); au lieu de setTimeout('doSomething', 1000);
  • Utiliser des variables locales avec var.

HTML

  • Le balisage sémantique. Utilisez les balises appropriées. Ne pas mettre <br /> est là pour ajouter de l'espace, ajuster les marges et les règles CSS.
  • Tous les tags sont minuscules .
  • Toutes les balises doivent fin avec une balise de fermeture ou être auto fermante .
  • Faire usage des classes pour la mise en page similaire. Avoir un couple de classes prédéfinies comme hide, clear, error, etc.
  • Tout (scripts inclus) devrait aller dans <head>. Inquiétude au sujet de l'optimisation (déplacement des choses autour) quand il pose un problème.
  • et la source externe stylesheets JavaScript est un must à moins qu'il est spécifique de la page.

PHP

  • Les cadres sont bons, je recommande CodeIgniter.
  • Si vous ne souhaitez pas utiliser un cadre, essayez d'utiliser la dernière version de PHP possible. (Cela signifie 5.3).
  • Utilisez includes à votre avantage.
  • injections claires ou utiliser des déclarations préparées.

  • Effectuer si les contrôles sur les valeurs préconçues ne sécurisées. 

    $logged_in = false;
if(check_user($user))
{
     $logged_in = true;
     $user = load_user($_SESSION);
}
  • Connaître la différence entre guillemets simples et doubles. Utilisez des guillemets simples lorsque cela est possible.
  • Ne pas écho HTML.

Autres conseils

Gardez le 3 séparé. Le code maintenable moins que je rencontre toujours quand il y a un peu de PHP qui fait écho à un grand nombre de JavaScript et HTML, probablement avec une certaine SQL jeté autour pour faire bonne mesure.

Garder tous comme séparé fera le code beaucoup plus facile à maintenir, et fait aussi des choses beaucoup plus simple si vous avez des gens travaillant sur les différentes parties de l'application, comme designer qui n'a besoin que de travailler avec le HTML / CSS.

Il y a un peu de lecture pour l'inspiration:

  • Zend Framework - style de codage php : Liste des pratiques comment écrire un code maintable php (formatage des fichiers PHP, conventions de nommage, style de codage:. tableaux, cordes, classe, méthode par exemple).
  • Google - guide de style Code: Liste des pratiques pour l'écriture code javascript maintable (Règles: Constans, points-virgules, blotti Fonction ..., le style de codage. Naming, champ, Chaîne, champs de visibilité, etc.).

La meilleure façon de coder une application web php est certainement tout mash ensemble. Vous liquidez rapidement avec un désordre ingérable si vous faites les choses de cette façon, cependant.

Voici quelques bonnes pratiques:
1) Mettez votre JavaScript dans la section d'un document (ou, mieux encore, dans des fichiers séparés qui sont référencés dans la tête). Apprenez à lier écouteurs d'événement dans un événement document.onload, plutôt que de les éparpiller à travers votre code html. (Mieux encore, apprendre à utiliser un cadre comme Jquery, ça va rendre votre JavaScript beaucoup, beaucoup plus joli).

2) Rechercher des modèles de conception comme MVC. Vous voulez séparer votre logique métier, écrit en PHP, à partir de votre HTML, autant que possible. Idéalement, vous vous retrouvez à l'aide d'une belle langue de templating de mettre en place vos pages HTML; à tout le moins, le PHP dans votre code HTML doit être laconique -. surtout appeler les variables et le bouclage des listes qui sont construites ailleurs

3) Commentaires, ... indenter ce genre de choses est tout simplement les meilleures pratiques de programmation de base. J'ai tendance à laisser mon aller longueur de ligne au-dessus de 80 caractères quand je suis en train d'écrire HTML, juste parce que la langue est si sacrément bavard, mais qui est sur la seule pratique traditionnelle, vous devez laisser glisser - si le reste de l'équipe est d'être bâclée, ils ont besoin pour le sucer et prendre forme.

Voici quelques petits morceaux:

Javascript. Utilisez var lorsque les variables initialisant

HTML: Inclure des scripts au bas du fichier afin qu'ils se chargent dernier

.

PHP: Split les fichiers vers le haut. Ne mettez pas toutes vos classes dans un seul fichier, comme vous le feriez pas dans le développement normal de C ++. Commentaire autant que possible et de noter également le but de vos fonctions / classes.

Licencié sous: CC-BY-SA avec attribution
scroll top