Discussion :

[tim91700]

Bonjour,

Je souhaiterais avoir quelques informations et aides afin de bien commenter mon ficher .c

Voila le code de la fonction (simple) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
#include <stdlib.h>
#include <stdio.h>
 
int main (int argc, char** argv){
 
  int i,n,tmp;
  int j;
  int tab[5]={1,2,3,4,5};
  int tab1[5]={6,7,8,9,10};
  n=5;
  tmp=0;
 
  for(i=1;i<=n;i++){
    for(j=1;j<n;j++){
      tmp=tmp+(tab[i]*tab1[j]);
	     }
    }
printf("Le schtroumpf des deux tableaux est de %d\n",tmp);
 
 
 return EXIT_SUCCESS;
}

Voila le commentaire :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
\**
*\file tp2question5.c
*\author Moi
*\version 1.0
*\brief Verifie si les élements d'un tableau sont de meme signe
*\date 25 Janvier 2011
*/

Mon prof d'informatique me demande creer un ficher .h afin de commenter la fonction.

Sachant que le but final est de faire un menu, avec toutes les fonctions.
D'après ce que j'ai compris, au-lieu de mettre int, il fait mettre void et ensuite modifié un paramètre dans le fichier .h .

Merci d'avance pour votre aide.

[matafan]

Je n'ai pas compris ce que tu demandes. Il me semble que ta question est plus que la façon de découper un programme en plusieurs fichier que sur la façon de commenter un programme (en passant, les commentaire débutent par /* et pas pas \*).

Je pense que ce que ton prof te demandes, c'est de ne pas faire le traitement directement dans le main(), mais de créer une fonction qui prendra en argument les deux tableaux et retournera le résultat. Cette fonction sera définie dans un fichier séparé.

Tu auras donc un fichier .c contenant la définition de la fonction, un fichier .h associé contenant la déclaration de la fonction, et un troisième fichier .c qui contiendra le main(). Ce troisième fichier inclura le .h.

[sam1507]

Pour générer de la documentation avec Doxygen à partir des fichiers sources (.h, .c), il faut commenter ces fichiers en utilisant les commandes appropriées.

La liste des commandes est ici : http://www.stack.nl/~dimitri/doxygen/commands.html

Exemple de commentaires (commentaires qui m'ont bien fait rire d'ailleurs ^^) :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
/*! \class WindowsNT
 *  \brief Windows Nice Try.
 *  \author Bill Gates
 *  \author Several species of small furry animals gathered together 
 *          in a cave and grooving with a pict.
 *  \version 4.0
 *  \date    1996-1998
 *  \bug It crashes a lot and requires huge amounts of memory.
 *  \bug The class introduces the more bugs, the longer it is used.
 *  \warning This class may explode in your face.
 *  \warning If you inherit anything from this class, you're doomed.
 */
 
class WindowsNT {};

Là c'est pour une classe mais ça marche pour tout.

[tim91700]

Désole pour l'explication, mais l'aide que je souhaite est comme matafan l'a écrit.
Voila à quoi je pense :

fichier 1 : le programme avec la fonction (*.c)
fichier 2: le fichier de declaration de la fonction (*.h)
fichier 3 : le fichier qui appelera le fichier *.h

Est-ce exacte ?

Merci encore pour votre aide

[sam1507]

Il faut faire ce que matafan a expliqué, à savoir 3 fichiers :

• tp2question5.c (définition de la fonction)
• tp2question5.h (déclaration de la fonction + commentaires doxygen)
• main.c (appel de la fonction)

Je pense que c'est ça que veut ton prof.