[Rapport de stage info] Mettre le code dans les annexes ?

Panzerjo MILKS · 29/05/2007, 22h15

Oué question à la con je sais, mais bon ca me perturbe trop ^^
Voila je finis de rédiger mon rapport de stage info, et j'arrive pas à savoir si je met tout le code que j'ai tappé en annexe. Est ce que je met tout, une partie, rien du tout ? Sachant que le code est pas mal commenté, et de manière général assez lisible.

(j'ai mis sur le labo vu que c'est de la prog, mais si ca va sur la taverne c'est tout aussi bien ^^)

Mikushi · 29/05/2007, 22h36

Moi j'avais juste mis une partie du code, les parties intéressantes uniquement, parce que bon dans le code tout n'est pas intéressant à montrer, et ça peut faire beaucoup de page en annexe, je trouve que ça peut faire trop

Certains de mes camarades avaient uniquement les classes ayant servies dans le développement, d'autres on tout mit, et d'autres encore n'ont pas mis leur code

Mais je pense que le meilleur compromis c'est d'en mettre qu'une partie, histoire de laisser un échantillon de ton boulot

Moine Gourmand · 29/05/2007, 22h52

C'est ce que j'avais fait aussi dans mes rapports de stage.

J'avais mis des portions de code plus importantes que le reste (une ou 2 classes PHP), et souvent développée à l'occasion du stage et aussi des trucs pas vu en cours.

Kathar - Alleria - Lango · 30/05/2007, 10h43

Je vois souvent des étudiants mettre du code en annexe de rapports (TP, projets, stages).
J'ai jamais vraiment compris l'intérêt... Vous croyez vraiment que le correcteur va lire le code ?

Autant avoir le code en version électronique c'est utile (pour compiler et tester, éventuellement regarder un peu), autant en version papier, c'est totalement indigeste. Je ne lis jamais.

Bref, à moins qu'on t'ait demandé explicitement le code, c'est inutile. Si tu veux insister sur le fait que tu as produit beaucoup de code, tu peux toujours mettre une phrase dans ta conclusion (ou dans le corps du rapport) pour expliquer que tu as développé 25000 lignes de code, qui forment 300 classes.

Akis · 30/05/2007, 10h59

Citation :

Publié par Lango

...

Dans mon école, pour les projets, on doit mettre tout le code source en annexe... (malgré le fait qu'on rend le programme et tout sur cd)

L'intérêt, c'est de pouvoir mieux analyser le code, c'est plus facile pour les gens de lire une feuille que de lire à l'écran.
Et je vois mal les profs imprimer des milliers de pages à chaque fois donc ils demandent aux étudiants.

Maintenant, ton code doit être sacrément plus long que ce que l'on faisait dans nos projets donc je ne sais pas.. Mettre le code "intéressant" ?

Trint · 30/05/2007, 11h13

Citation :

Publié par Akis

Dans mon école, pour les projets, on doit mettre tout le code source en annexe... (malgré le fait qu'on rend le programme et tout sur cd)

Chez nous, il est interdit de mettre du code dans le corps du rapport.

Si on veut, on peut en mettre en annexe, ça veut dire qu'il ne sera pas lu.

Imladir · 30/05/2007, 11h19

Y'a aussi le problème de savoir à qui appartient ce code, la boite dans laquelle tu as fait ce stage sera-t-elle d'accord pour te laisser produire le code comme ça, même à ton école ?

Je suis dans la dernière partie de mon stage de 6 mois et je vais commencer à rédiger mon rapport aussi, mais je ne compte pas du tout mettre en intégralité le code que j'ai développé, d'une part parce que c'est des trucs un peu sensibles quand même, ensuite parce que ça serait beaucoup trop long, et complètement indigeste, j'imagine déjà la tête du jury qui tombe sur un rapport avec 300 pages de code...

Après, mettre quelques fonctions ou classes, un bout de script SQL oui pourquoi pas, ça peut toujours être utile, à condition de choisir des exemples pertinents.

Drys Kaine · 30/05/2007, 12h14

Citation :

Y'a aussi le problème de savoir à qui appartient ce code, la boite dans laquelle tu as fait ce stage sera-t-elle d'accord pour te laisser produire le code comme ça, même à ton école ?

Tout dépend de la convention de stage et de la présence ou non d'une clause de non-divulgation ( personnellement, je n'en ai eu qu'une fois sur les 4 stages que j'ai fait ).

Guitou · 30/05/2007, 12h31

Dans le rapport directement, ne pas mettre le code, uniquement quelques morceaux choisis. Par contre en annexe certains aiment bien le regarder pour voir la façon dont tu ordonnes le tout (indentation, typage des variables, fonctions utiles...).
Donc si tu es sûr de ton code (propre, lisible, etc) vas-y, ou bien sûr s'il est expressément demandé.

Epeda · 30/05/2007, 12h33

Durant mes stages, les profs qui étaient chargés de moi m'ont toujours formellement défendu de mettre du code. Et c'est vrai que ça n'a absolument aucun intérêt.

A ta place, même en annexe je me ferais pas chier à en mettre.

Furiouss · 30/05/2007, 12h47

Moi j'ai fait la betise d'en mettre dans le corps du rapport en DUT, bon c'était surtout pour présenter certaines fonctions où j'en avais chier, mais ça m'a été repproché.
En annexe, j'ai mis quelques trucs importants, là on m'a rien dit.

En licence, 0 code, j'ai même pas le souvenir d'en avoir mis en annexe, et ça c'est bien passé par contre

Grosbisou · 30/05/2007, 13h02

Le mec qui va te lire s'en tape de ton code, il veut juste savoir ce que t'as fait. Alors profite ! Oublie les free ! :x

Kathar - Alleria - Lango · 30/05/2007, 13h16

Citation :

Publié par Akis

Dans mon école, pour les projets, on doit mettre tout le code source en annexe... (malgré le fait qu'on rend le programme et tout sur cd)

L'intérêt, c'est de pouvoir mieux analyser le code, c'est plus facile pour les gens de lire une feuille que de lire à l'écran.
Et je vois mal les profs imprimer des milliers de pages à chaque fois donc ils demandent aux étudiants.

Comme j'ai dit plus haut, le code sur papier, c'est illisible. Pas de coloration syntaxique, pas moyen de chercher vite la définition de telle fonction appelée, etc.

Un code sur papier, on peut le survoler vaguement pour regarder le style de programmation («est-ce que tel bout de code pris au hasard est clair ?»), mais pas plus.
Surtout que lire des rapports de stage, c'est déjà assez long comme ça.
Ça n'a aucun intérêt dans un rapport. Sauf si ce sont les consignes, bien entendu.

Yasoldar · 31/05/2007, 10h14

Tu peux mettre un point en particulier : telle partie qui montre que ton année à été bénéfique et correspond à telle partie du cours, ou telle partie qui t'as posé un probleme et comment tu l'as contourné...

Sinon, du code pour du code (ou up ton page-count

) l'interet est pour le moins, limité...

Citation :

Publié par lango

Comme j'ai dit plus haut, le code sur papier, c'est illisible. Pas de coloration syntaxique,

C'est vrai que c'est compliqué ça, oui...

Akis · 31/05/2007, 10h29

Rien n'interdit d'imprimer en couleur

Enfin ceci dit, c'est vrai qu'avoir des centaines, voir des milliers, de pages sources, c'est pas franchement pratique :/

Bratisla · 31/05/2007, 10h40

Citation :

Publié par Akis

Rien n'interdit d'imprimer en couleur

Paie tes dizaines de pages imprimées en couleur sur l'imprimante, pour chaque rapport. Déjà qu'en temps normal, faute de sous, les cartouches d'encre couleur ne sont pas prioritaires dans les labos ... Si c'est l'étudiant qui imprime lui-même son rapport, lui aussi est bon pour douiller.
Et la coloration syntaxique, on peut limite s'en passer, mais la navigation pour trouver les définitions de fonction et autres, pas moyen quoi. Donc claquer de la couleur pour pas grand-chose, ayons pitié de la nature

Krogoth · 31/05/2007, 14h43

Lors de mon stage on nous avais dit de ne pas le mettre. Eventuellement des petits bout de code interessant. Mon j'avais mit le code d'un programme qui tennait sur 2 pages et c'était pour montrer la structure du code, pas l'algo.

Pour Lango, je connais beaucoup de personne qui apres quelques années de dev virent la coloration syntaxique car ca leur sort par les yeux.

Panzerjo MILKS · 31/05/2007, 15h20

Merci bien. Je vais mettre deux trois fonction dont je parle dans mon rapport dans les annexes, ainsi que le scripte de création des bases de données que j'utilise, ce qui devrait suffire je pense ^^

Dracan Sakan · 31/05/2007, 18h44

Citation :

Publié par Drys Kaine

Tout dépend de la convention de stage et de la présence ou non d'une clause de non-divulgation ( personnellement, je n'en ai eu qu'une fois sur les 4 stages que j'ai fait ).

Meme sans close de non divulgation, le code source de l'appli appartient normalement à la boite dans laquelle tu as fais ton stage...

Perso, j'avais juste mis des petits bouts de codes bien spécifiques qui illustraient bien la partie traitée et ce de manière très limitée.

Après, ça dépend aussi de la structure de ton rapport. Si c'est orienté méthodologie avec itérations etc, ça peut être intéressant pour bien illustrer les différentes phases de développement.

Mais pour moi, mettre le code source dans les annexes, ça apporte rien, sinon un gaspillage de papier. (Et soit dit en passant, ça fait un effet "remplissage" qui n'est pas toujours de la meilleure impression.)

Kathar - Alleria - Lango · 01/06/2007, 11h34

Citation :

Publié par KROGOTH

Pour Lango, je connais beaucoup de personne qui apres quelques années de dev virent la coloration syntaxique car ca leur sort par les yeux.

J'aimerais bien voir ça... ou alors c'est parce que leur éditeur fait une coloration syntaxique pourrie...

La coloration syntaxique, ça améliore énormément la lisibilité d'un programme. J'aurais vraiment du mal à m'en passer.

Mothra · 01/06/2007, 16h08

Contentes toi de citer le nombre de lignes de code et le langage, le code de toute facon personne ne le lira. En outre il est parfois couvert par du NDA. Ta conclusion est l'endroit parfait pour resumer tes "achievements", et en particulier discuter du volume de code et de ses caracteristiques principales avec une phrase "J'ai develloppe un systeme de ... representant x lignes de code C, a partir d'une base fournie/en assurant la conception complete ...

Moine Gourmand Alpha & Oméga	C'est ce que j'avais fait aussi dans mes rapports de stage. J'avais mis des portions de code plus importantes que le reste (une ou 2 classes PHP), et souvent développée à l'occasion du stage et aussi des trucs pas vu en cours.
29/05/2007, 22h52

Trint Alpha & Oméga	Citation : Publié par Akis Dans mon école, pour les projets, on doit mettre tout le code source en annexe... (malgré le fait qu'on rend le programme et tout sur cd) Chez nous, il est interdit de mettre du code dans le corps du rapport. Si on veut, on peut en mettre en annexe, ça veut dire qu'il ne sera pas lu.
30/05/2007, 11h13

Drys Kaine Alpha & Oméga	Citation : Y'a aussi le problème de savoir à qui appartient ce code, la boite dans laquelle tu as fait ce stage sera-t-elle d'accord pour te laisser produire le code comme ça, même à ton école ? Tout dépend de la convention de stage et de la présence ou non d'une clause de non-divulgation ( personnellement, je n'en ai eu qu'une fois sur les 4 stages que j'ai fait ).
30/05/2007, 12h14

Guitou [CPC] Alpha & Oméga	Dans le rapport directement, ne pas mettre le code, uniquement quelques morceaux choisis. Par contre en annexe certains aiment bien le regarder pour voir la façon dont tu ordonnes le tout (indentation, typage des variables, fonctions utiles...). Donc si tu es sûr de ton code (propre, lisible, etc) vas-y, ou bien sûr s'il est expressément demandé.
30/05/2007, 12h31

Epeda Alpha & Oméga	Durant mes stages, les profs qui étaient chargés de moi m'ont toujours formellement défendu de mettre du code. Et c'est vrai que ça n'a absolument aucun intérêt. A ta place, même en annexe je me ferais pas chier à en mettre.
30/05/2007, 12h33

Furiouss Alpha & Oméga	Moi j'ai fait la betise d'en mettre dans le corps du rapport en DUT, bon c'était surtout pour présenter certaines fonctions où j'en avais chier, mais ça m'a été repproché. En annexe, j'ai mis quelques trucs importants, là on m'a rien dit. En licence, 0 code, j'ai même pas le souvenir d'en avoir mis en annexe, et ça c'est bien passé par contre
30/05/2007, 12h47

Grosbisou Alpha & Oméga	Le mec qui va te lire s'en tape de ton code, il veut juste savoir ce que t'as fait. Alors profite ! Oublie les free ! :x
30/05/2007, 13h02

Akis Alpha & Oméga	Rien n'interdit d'imprimer en couleur Enfin ceci dit, c'est vrai qu'avoir des centaines, voir des milliers, de pages sources, c'est pas franchement pratique :/
31/05/2007, 10h29

Krogoth Alpha & Oméga	Lors de mon stage on nous avais dit de ne pas le mettre. Eventuellement des petits bout de code interessant. Mon j'avais mit le code d'un programme qui tennait sur 2 pages et c'était pour montrer la structure du code, pas l'algo. Pour Lango, je connais beaucoup de personne qui apres quelques années de dev virent la coloration syntaxique car ca leur sort par les yeux.
31/05/2007, 14h43

Panzerjo MILKS Alpha & Oméga	Merci bien. Je vais mettre deux trois fonction dont je parle dans mon rapport dans les annexes, ainsi que le scripte de création des bases de données que j'utilise, ce qui devrait suffire je pense ^^
31/05/2007, 15h20

[Rapport de stage info] Mettre le code dans les annexes ?

Connectés sur ce fil