Discussion :

[whitespirit]

Bonjour,

Je pose une question un peu b�te, mais existe-il une norme d'�criture "officiel" (ie, utilis� par une majorit� de d�veloppeur c++ builder) pour les commentaires de fonctions et classes (nom, but, entr�e, sortie, remarque)? Si oui laquelle ?

Je souhaiterai homog�n�is� le code produit par nos d�veloppeurs pour des raisons �videntes.

Merci de vos r�ponses futures.

[Crayon]

Je ne crois pas qu'il existe de norme pour C++Builder. S'il en existait une, les exemples de codes de Borland serais fais de cette mani�re. La seule chose qu'ils font c'est de mettre un copyright dans le haut des fichiers .cpp et .h.

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
//----------------------------------------------------------------------------
//Borland C++Builder
//Copyright (c) 1987, 1998-2002 Borland International Inc. All Rights Reserved.
//----------------------------------------------------------------------------

Le mieux serais de faire ton propre standard pour ta compagnie.

Pour mes fonctions j'utilise:

Code :

S�lectionner tout - Visualiser dans une fen�tre � part

1
2
3
4
5
6
7
//------------------------------------------------------------------------------
// Input:   var  - var desc
//          var2 - var2 desc
// Output:  Rien
// Return:  Quelque chose
// Purpose: Fonction qui sert à la redistribution de patates aux utilisateurs
//------------------------------------------------------------------------------

[whitespirit]

En fait, je pensais qu'il existais une norme pour g�n�rer directement un fichier d'aide aux fonctions et classe sans r��crire. Je me souviens, quand j'avais �tudi� Java il y'a qq temps, je mettais des @ des /* */ ... C'�tait il y'a fort fort lointain.

[bakaneko]

Pour g�n�rer une aide sur mes classes/m�thodes, j'utilise le formalisme utiliser pour Doxygen.
Cela marche pas trop mal et j'ai ainsi pu g�n�rer une aide au format html que j'ai mis en ligne sur le serveur de ma soci�t�. Ainsi mon partenaire de d�veloppement ne me court pas apr�s pour savoir comment mes m�thodes fonctionnent

[whitespirit]

Merci, si vous utilisez d'autres outils, n'h�sitez pas � poster un message. Je me permets de laisser cette discussion ouverte et ainsi ne pas appliquer le Tag "r�solu" maintenant.

A bient�t.