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.