BTS IG Informatique de Gestion

Newbiiiie Messages: 10

Bonjour, je prépare mes oraux de PTI et j'ai une question au sujet de laquelle je n'arrive pas à trouver d'informations :

Est il autorisé de commenter les lignes de code de ses PTI afin de ne pas sécher si l'on oubli la signification d'une ligne ?

Si oui, jusqu'à quel point ? Imaginons qu'une ligne sur deux soit commentée par exemple est ce que cela peut être pénalisant si le jury le remarque ?

Merci beaucoup, si quelqu'un a des info la dessus ça me serait d'une grande aide ! Smile

Webmaster Sexe: Messages: 5584 Localisation: Montpellier

Un code commenté justement c'est quelque chose de bien.
De sorte justement à avoir un code qui puisse être compréhensible par quelqu'un qui n'a pas développé le script (ou quelques années plus tard, quand on a oublié comment fonctionnait son script).

Par contre, si tu commentes une ligne sur 2 en mettant chaque ligne à quoi correspond la commande, tu vas perdre toute crédibilité.
Le commentaire est plus d'ordre "fonctionnel". Pour expliquer à quoi sert le paragraphe vis à vis de l'application. Pas pour expliquer à quoi sert la ligne au sens technique du terme.

Forumeur fréquent Messages: 89

La documentation du code doit se faire en début de bout de code (fonction ou proc). Je te conseil d'aller voir comment fonctionne la JavaDOC (disponible pour les autres langages). Une ligne sur deux ca te décrédibilise comme à dit Vincent, ca fait développeur pas sur de lui ou qui ne connait pas son code... Une ligne de code au début pour le résumé et une ligne pour les paramètres retournés (s'il y en a) ca suffit.

Newbiiiie Messages: 10

Oui c'est bien ce que je pensais,

Merci beaucoup pour vos réponses, je sais maintenant comment je dois le faire.

Bonne soirée !