Hmm, j'ai lu cette question légèrement différemment de Robert qui affirme correctement que le code mis en commentaire doit être supprimé.
Si, toutefois, vous recherchez une convention pour marquer le code en vue de son retrait ultérieur, l'un de mes favoris est le suivant:
//b = false; //TODO: remove
Certains drapeaux de l'EDI //TODO:
peuvent être commentés ou commentés. Sinon, c'est généralement une chaîne interrogeable. Il est préférable de suivre la convention établie par votre boutique, car cela peut se faire de plusieurs manières. Chaque base de code devrait le faire d'une manière. Le maintient consultable.
analyser rapidement lequel est lequel?
Sans cette marque, la méthode automatisée consiste à utiliser le compilateur. Si supprimer le commentaire produit un code compilé, il doit s'agir d'un code commenté. Ecrire un plugin IDE qui vérifie que ce ne serait pas difficile. Mais il laissera du code commenté buggy derrière.
C'est pourquoi il est préférable de simplement marquer le code commenté comme code dès que vous le commentez. Cela vous permet de travailler de manière non destructive pendant que vous décidez si vous le souhaitez vraiment. Puisque nous sommes tous interrompus et oublions quelque peu, ne soyez pas surpris si certaines lignes sont enregistrées alors qu'elles sont dans cet état. S'ils le font, c'est bien qu'ils soient au moins clairement identifiés et consultables. Les macros de clavier m'ont aidé avec cela dans le passé. Il est difficile de s’interrompre au milieu de cela si vous pouvez le faire en appuyant simplement sur une touche.
Vous pouvez aller jusqu’à enchâsser la marque dans vos tests d’intégration continue. Oups, j'essaie de vérifier à nouveau avec les TODO en suspens.
///
et les/** ... */
commentaires sont également utilisés par des générateurs de documentation, tels que Doxygen ou JSDoc. Si vous les utilisez ou utilisez des outils similaires, vous ne pourrez peut-être pas utiliser ce type de commentaire pour des commentaires descriptifs qui ne font pas partie de la documentation.