Quels sont les bons formats de code?

Question

Tout d'abord, je suis au courant de cette question: Are there standard formats for comments within code?

Mais il n'a pas répondu à la mienne. Chaque fois que j'écris du code, j'essaie toujours de m'assurer que les commentaires sont tous cohérents, mais c'est là que je suis parfois indécis au sujet de ma convention de format de code. D'autant plus que je veux que mon code soit d'environ 80 lignes.

Inutile de dire, une convention de format de code doit être:

• Facile à lire
• Facile à modifier

Et il peut y avoir différents formats de commentaires dans les différentes parties de votre code, il est donc important de s'assurer qu'ils restent cohérents et lisibles.

Voici quelques exemples:

Ligne simple

// simple comment in lowercase 
do_something(); 

// longer comment in lowercase. but now it doesn't seem like a proper sentence. 
do_something(); 

// Longer comment in sentence case. But should we use sentence case for short comments too? 
do_something(); 
// Like this one? 
do_something_else(); // Or even this one. 

multi-ligne

// This code is very detailed and so I must continue further. 
// Every time you start a new line you need to ensure you add //. 
// If you finish your comment and forget to add something, you're screwed. 
// You'll have to add your something and then make sure all the lines are 80 characters or less, 
// and if they aren't you need to restructure all the lines below it. 

/* This is better but you need to make sure it's properly indented each line. 
    Although you have to worry about those comment delimiters getting in the way. 
    At least it's compact. */ 

/* This comment seems better. 
    No need to worry about that last delimiter being inside your comment block. 
*/ 

/* 
    Or maybe this is better? 
    At least it looks clean. 
*/ 

/* GOOD FOR FUNCTION DEFINITIONS 
    Or maybe this is even better? 
    Who knows? 
*/ 

Answer 1

Réponse 1 - ne sont pas, toute perte de temps sur les accolades est-argueing une perte de temps.

Réponse 2 - si vous devez, il suffit de choisir un exemple. http://www.possibility.com/Cpp/CppCodingStandard.html