Aller au menu - Aller au contenu

Centre d'aide Vous êtes ici : zCorrecteurs.fr > Les forums > Langue française > Orthographe et grammaire > Commentaires de code > Voir le sujet

Commentaires de code

Caractères spéciaux et accents

Résolu Le problème de ce sujet a été résolu.

Page : 1 
Auteur Message
0 membre et 1 visiteur.
Page : 1 
Hors ligne ptipilou # Posté le 07/12/2008 à 16 h 01
Sus à la faute !
Avatar de ptipilou
Messages : 9549
Groupe : Administrateurs
Bonjour à tous.

Depuis bien longtemps, je prends l'habitude de corriger (lorsque l'auteur ne l'a pas fait lui-même) les commentaires de code en leur rajoutant les accents et autres caractères spéciaux (à, ç, etc.), ayant lu çà et là que le compilateur n'interprétait pas les commentaires (j'ai même été traduire certaines documentations officielles, qui parlent d'un plain-english* (sic) mais qui n'ont jamais prévu qu'un village gaulois (Toute ? Non... :D ) utiliserait à tour de bras les accents et autres particularités de sa langue...

Seulement, récemment, l'auteur d'un tuto sur l'ActionScript m'a fait remarquer qu'il avait connu des avatars avec des caractères spéciaux, et cela à cause de l'encodage (UTF-8 ou ISO-8859-x, si j'ai bien compris). Ceux qui me connaissent (et qui me supportent :p ) savent mon extrême nullité technique (n'est-ce pas les zArchitectes, Ziame, dworkin ? ^^ ).

Du coup, j'ai un doute. Est-il dangereux de corriger ainsi les commentaires ? Est-ce que cela peut induire un risque d'interprétation du code ?
Merci pour vos commentaires.

Note : lorsque je vois la pratique de certains auteurs, quand j'observe l'absence d'accents, je comprends mieux les fautes qu'ils laissent dans leurs tutos. "surement" par exemple : comme ils ne rajoutent pas d'accent circonflexe dans leurs commentaires, ils prennent l'habitude de ne pas en mettre non plus dans le corps de leurs textes... Ils ont sans doute plus l'habitude d'écrire du code, et donc du commentaire, que du texte, ça doit être la raison !

* on pourrait traduire "plain-english" par "anglais clair"...

Cauchemar orthographique (qui a dit sadique ?)
 
Hors ligne Le Chapelier Toqué # Posté le 07/12/2008 à 18 h 32
Avatar de Le Chapelier Toqué
Messages : 812
Groupe : zAnciens
Ça ne nuira pas à l'interprétation/compilation du code, puisque les commentaires sont ignorés, mais ils seront remplacés par d'autres caractères (ÃŽ, é, Ú, ...) si le fichier n'est pas ouvert avec le bon encodage.

Dans ce cas, on peut dire que ça nuit à la compréhension des commentaires pour l'humain. ;)
Modifié le 07/12/2008 à 18 h 32 par Le Chapelier Toqué
 
Hors ligne Ziame # Posté le 07/12/2008 à 18 h 43
Arx Tarpeia Capitoli proxima
Avatar de Ziame
Messages : 11523
Groupe : Administrateurs
Cette réponse a aidé l'auteur du sujet Cette réponse a aidé l'auteur du sujet.
Bonjour,

Ça me paraît bizarre que ça fasse planter une compilation en tout cas, normalement il n'y a pas de problème à ce niveau (du moins pour les langages que je connais). En PHP, C, Maple, JavaScript etc. ça ne pose pas de problème.

Bref pour répondre à ta question, je ne pense pas (mais je peux me tromper).

Si vous aimez écrire et que vous avez des choses à dire sur l'un des thèmes que couvre notre blog, n'hésitez pas ! ;)
 
Hors ligne Dalshim # Posté le 07/12/2008 à 19 h 04
Avatar de Dalshim
Messages : 535
Membres
Je suis du même avis que Le chapelier toqué, les commentaire sont retiré à la précompilation, aucun risque en théorie.
Peut être as-tu corrigé un accent sur un commentaire qui n'en était pas un, non ?

En revanche, il est vrai que ça peut poser des problème de compréhension si le lecteur ouvre le fichier source avec le mauvais encodage.
 
Hors ligne ptipilou # Posté le 07/12/2008 à 20 h 27
Sus à la faute !
Avatar de ptipilou
Messages : 9549
Groupe : Administrateurs
Merci pour vos précisions. L'auteur m'a donné quelques réponses (je ne vois pas tout à fait le rapport avec la choucroute, mais je suis incompétent - en la matière), extrait de notre conversation :
Citation : Lui
Okey je te laisse le corriger et cela dit pour les accent, j'ai eu un problème dans un fichier XML de conf pour un site de J2EE donc faire attention, ils ne sont pas gérés partout en fonction de l'encodage.
Dans les commentaires ??? Citation : Lui
Oui j'ai mis du temps à comprendre d'où ça venait
Le problème d'encodage (je suis nul) peut-il provenir de la configuration de la machine du visiteur ? Je veux dire : il peut avoir différence de traitement des commentaires selon que l'encodage est en UTF-8 ou en ISO-8859-x ???Citation : Toujours lui
J'étais sur un XP donc le problème devait venir du lecteur du fichier xml qui ne devait gérer que des caractères basic. Sinon niveau encodage pareil je suis un peu à la ramasse.
C'est un point qu'il faudra que j'éclaircisse, de toute manière.
Il me reste beaucoup de tutos Programmation à corriger, je ne voudrais pas que le travail de celui qui les ont écrits me coupent les mains.Citation : Et enfin, lui
Après quelques recherches, je compris que les problèmes majeurs d'encodage venaient des projets J2EE donc ca limite les problèmes. Enfin il vaut quand même mieux éviter les accents dans le noms de variable ne serais-ce que pour la normalisation.


Avez-vous remarqué la trivialité de ma parenthèse (je m'en suis rendu compte avec décalage et... gêne) ??? :p

Cauchemar orthographique (qui a dit sadique ?)
 
Hors ligne Le Chapelier Toqué # Posté le 07/12/2008 à 21 h 16
Avatar de Le Chapelier Toqué
Messages : 812
Groupe : zAnciens
Cette réponse a aidé l'auteur du sujet Cette réponse a aidé l'auteur du sujet.
Dans le code, il vaut mieux éviter les caractères spéciaux, dont les accents. Honnêtement, je ne sais pas ce que ça donne.

Dans les commentaires, même si ça ne change rien côté exécution, des lettres accentuées mal affichées sont plus embêtantes que des commentaires sans accents. Il faut ajouter à ça les conventions qui font que tout code-source est normalement rédigé en anglais (variables et commentaires) et donc sans accent... Toutefois, dans un tuto, le code n'a pas vocation à être modifié sur une autre machine mais à être lu sur un site qui gère l'UTF-8.
On peut donc accentuer les commentaires dans un tuto, même si un "vrai" code-source ne l'est pas.

C'est selon les configurations du système d'exploitation qu'un fichier sera, par défaut, encodé selon tel ou tel encodage. Malgré cela, la plupart des éditeurs de texte dignes de ce nom permettent de modifier l'encodage lors de l'ouverture/enregistrement et supportent les encodages classiques (ISO et UTF au minimum).
Sinon, je ne sais pas si c'est modifiable dans un IDE (logiquement, cela devrait).

Oui, selon ces préférences, les commentaires accentués seront ou ne seront pas bien affichés.
Modifié le 07/12/2008 à 21 h 17 par Le Chapelier Toqué
 
Hors ligne Dalshim # Posté le 07/12/2008 à 21 h 31
Avatar de Dalshim
Messages : 535
Membres
Cette réponse a aidé l'auteur du sujet Cette réponse a aidé l'auteur du sujet.
Citation : ptipilou
Citation : Et enfin, lui
Après quelques recherches, je compris que les problèmes majeurs d'encodage venaient des projets J2EE donc ca limite les problèmes. Enfin il vaut quand même mieux éviter les accents dans le noms de variable ne serais-ce que pour la normalisation.


On notera qu'il parle ici de variable avec un accent et non plus d'un commentaire. Je pense que tu as modifier le nom d'une variable qui devait se trouver dans un commentaire type javadoc et que la javadoc devait être utilisé pour le fichier XML.
Je reste encore TRÈS septique quand a un commentaire pouvant faire beuguer un programme, il devait y avoir eu une correction dans le fichier XML ou quelque chose du genre.
 
Hors ligne ptipilou # Posté le 07/12/2008 à 21 h 44
Sus à la faute !
Avatar de ptipilou
Messages : 9549
Groupe : Administrateurs
Merci à tous pour vos réponses étayées, et doctes.

C'est un peu ce que je pensais. Là, on faisait référence à l'ActionScript, je suis même allé dans la doc officielle (en) d'Adobe pour vérifier. C'est d'ailleurs à ce propos que je parle plus haut de plain-english (Le Chapelier, tu as raison d'évoquer l'absence d'accents dans cette langue, je l'avais compris comme tel aussi). D'une manière générale, pour avoir compulsé bon nombre de langages par les tutos du SdZ, mais aussi ailleurs, j'avais comme toi, Dalshim, de sérieux doutes sur l'interprétation des commentaires. En tout cas, si je ne peux pas être catégorique faute de compétences, je comprends qu'ils n'ont aucune portée lors de l'action du compilateur du code puisque ce dernier ignore purement et simplement ces explications.

Et je crois comprendre aussi que chaque "inventeur" de langage informatique aura pris soin d'agir de même, quel que soit le langage dont on parle...

Et non, je n'ai pas touché aux variables. Je me l'interdis, pour tout dire, je ne fais que faire remarquer (fidèle à la charte ^^ ) à l'auteur que par exemple, il me semble que telle ou telle chose peut sembler erronée, et encore, avec beaucoup d'humilité. Parfois, cela permet d'éviter une belle coquille, mais en lisant les commentaires, ça aide parfois.

Une belle épine du pied retirée, merci encore pour vos contributions. ;)

Cauchemar orthographique (qui a dit sadique ?)
 
Hors ligne stallaf # Posté le 17/12/2008 à 20 h 37
Humble, tu seras...
Avatar de stallaf
Messages : 78
Membres
Cette réponse a aidé l'auteur du sujet Cette réponse a aidé l'auteur du sujet.
Bonjour,

Citation : Un 'gourou' du langage C a écrit :
" Personnellement, j'évite d'utiliser les caractères autres que les caractères standards dans un code-source, y compris dans les commentaires. "

Dans tous les langages, en cas de problème, le comportement sera indéfini.
Il faut appliquer le principe de précaution.
Modifié le 17/12/2008 à 21 h 54 par ptipilou

Visiteur, Membre, Modo et enfin Admin, tu deviendras.
 
Hors ligne ptipilou # Posté le 17/12/2008 à 21 h 57
Sus à la faute !
Avatar de ptipilou
Messages : 9549
Groupe : Administrateurs
Là aussi, l'explication tient la route.
C'est bien vu. Mais si cela n'est expliqué nulle part, faut comprendre aussi le point de vue du lecteur béotien. S'il lit un tuto dans lequel il n'y a (presqu')aucune faute, et que dans les commentaires il en voit, il va se poser des questions, non ?

De la même manière, j'ai appris récemment que si des caractères spéciaux figuraient dans les commentaires, ils risquaient (seulement) d'être illisibles parce que remplacés (par exemple) par des points d'interrogation par le navigateur. Le risque est faible : le tuto se veut un exemple, et non pas un script tout fait.

Je crois qu'on a fait le tour de la question : merci, stallaf. ;)

Cauchemar orthographique (qui a dit sadique ?)
 

Retour au forum Orthographe et grammaire ou à la liste des forums