• [^] # Re: Ascii art en commentaire dans les sources

    Posté par . En réponse au journal à quand un code commenté ?. Évalué à 3.

    A part faire des fichiers plus gros, rendre l'édition plus chiante pour aligner les fins de lignes, et alourdir la lecture, ça apporte quoi ?

    Ca apporte aussi des commentaires qui ne correspondent plus à ce que fait la fonction, par ce que la dernière personne qui a modifié à eu la flemme de mettre à jour le commentaire.

    Sinon, ne surtout pas oublier non plus les commentaires qui repetent les noms de fonctions, les paramètres et autres infos inutiles. Exemple :



    /****************** function machin truc *************************/
    * This is the implementation of function machin truc, which */
    * does machin truc */
    * Name of the function: machin truc */
    * Number of Parameter(s) : 2 */
    * Last modified : 23/02/01 */
    * Parameter(s) : */
    * - n : an integer (int) */
    * - z : a character (char) */
    /*****************************************************************/
    function machin_truc(int n, char z)
    {
    /* Begining of function machin_truc */
    ...
    /* end of function machin_truc */
    }
    /*-----------------------------------------------------------------------*/