2009-05-06 7 views
2
  • Vous permutez les commentaires ou les blocs de code pour afficher ou masquer le contenu rapidement?
  • Quelles sont les méthodes les plus courantes?
  • Existe-t-il une norme acceptée?
  • Faut-il éviter certaines méthodes? à savoir pourraient-ils être mal interprétés par certains moteurs?
  • Y at-il une alternative ou une meilleure solution à cela?

standard - ce que j'utilise pour couvrir la plupart des langues: CSS, JavaScript, PHP, ActionScriptExiste-t-il un standard pour afficher et masquer facilement le contenu?

/**/ visible /**/ 
/**\/ hidden /**/ 

HTML

<!----> visible <!----> 
<!----/> hidden <!----> 

PHP - Définir quelque chose comme $ hide fonctionne bien, d'autres variables peuvent être la production ou le dev - les grandes dalles peuvent alors être cachées et montré avec un changement de variable simple.

if(0){ hidden } 
if(1){ visible } 
if(!$HIDE){ content } // $HIDE defined elsewhere, visible if undefined 
+0

Vous ne savez pas pourquoi cette question a été rejetée? –

Répondre

2

Je pense que si vous pouvez contrôler ce programme est en cours de rendu, qui est le mieux (comme ce que vous avez fait dans le PHP). Une solution encore meilleure que ce que vous avez écrit (essentiellement une macro de préprocesseur locale) est de réellement casser votre code de rendu en fonctions qui génèrent des sous-parties des documents. Si vous n'en avez pas besoin, vous ne l'appelez pas, et vous avez une condition claire dans le code. C'est, par exemple, la façon dont MediaWiki est écrit. Sinon, dans des projets complexes, cela devient un gâchis.

Il y a de nombreux risques à coder en dur le commentaire dans le code. Parmi eux:

  • Très facile à gâcher le décommentant

  • ne sait pas ce qui a été commenté.

  • problème lorsque commenté les sections se chevauchent

  • erreurs Couper et coller

  • Tout ce que vous vouliez cacher est toujours accessible, affecte les moteurs de recherche, etc.

+0

Vous faites de bonnes affaires en évitant d'utiliser des commentaires pour cacher le code. –

+0

Merci. Je pense que l'utilisation de commentaires pour cela dans le code OOP est mauvaise mais j'admets que je le fais trop souvent moi-même. D'un autre côté, si je commente un bloc trop grand, cela signifie souvent que je pourrais refactoriser la fonction en plusieurs fonctions et ensuite ne pas en appeler. – Uri

+0

Je viens de me rendre compte que j'ai mal formulé ce commentaire en le faisant un double négatif, je voulais dire que vous faites de bonnes affaires contre l'utilisation de commentaires de cette façon. Oui, c'est pourquoi je suis intéressé par les alternatives car je sais que ce n'est probablement pas mieux mais je le fais toujours. –

2
/* 
Commented 
// */ 

//* 
Not commented 
// */ 
0

Je préfère utiliser un éditeur de texte qui comprend la structure du texte source que je suis en train d'éditer, et qui peut faire du pliage de code sur le bas est de structure comme analysée par l'éditeur.

Le pliage Vim ou Emacs répond à ce besoin.

1

Certaines personnes m'ont dit que la bonne façon de commenter des sections de C++, puisque nous n'utilisons apparemment plus le préprocesseur est d'utiliser une instruction if.

if(false) 
{ 
    chunk of code; 
} 

La théorie étant que le compilateur optimisera que le code mort sur le produit final, et ils peuvent être imbriqués, qui /* */ commentaires de style ne peuvent pas faire.

Cette théorie est fausse, bien sûr, parce que vous ne pouvez pas l'utiliser pour commenter des régions arbitraires de code, par exemple:

class Foo 
{ 
    void Bar(); 
    if(false) 
    { 
     int Baz(double); // WRONG!!! 
    } 
}; 

D'autre part, cela fonctionne parfaitement pour les langues comme python autoriser toute instruction dans un bloc, et qui manque également d'un préprocesseur standard ou de commentaires de bloc.