Commentaire de code
J’ai trouvé dans le code de quelques logiciels des formes intéressantes de commentaires. Le développeur a pris l’espace nécessaire pour expliciter son code. Il a profité de la châsse fixe des caractères de son éditeur (et de celui de ses lecteurs) pour hierarchiser et placer ses indications.
if (
// basic checking
empty($tab) === false
&& isset($tab['key1'])
&& isset($tab['key2'])
// check something more…
&& check($tab) === false
)
{
// execution
}
const input = [
/**
* Configuration
*/
'confirmConfigRegistration', // config/index.js → config/main-render.js
'getConfig', // config/index.js → config/main-render.js
];