Décrire simplement un programme

Bonjour à tous,

Dans le cadre de mon travail, j'ai codé plusieurs macros sur Excel qui sont très utiles au quotidien.
Je vais quitter mon poste (rien de grave : une mutation) et je souhaite que mes successeurs puissent aisément retravailler ces codes quand le besoin se fera sentir.
J'ai bien sûr essayé de coder le plus proprement possible, en organisant mon code comme une sorte de "texte argumenté".

Je connais le principe du GEMMA en automatismes, qui est probablement ce vers quoi je vais m'orienter, mais je me demandais s'il existait d'autres méthodes ? Je n'arrive à rien de concluant sur google.

Je vous remercie d'avance.

1 réponse

  • Votes
  • Date
  • Date décroissante
  1. Je crois qu'il y a un formalisme qui vient du pseudo code et qui est quelque fois utilisé en C, il faut mettre en commentaire :
    • les entrées
    • les sorties
    • et une description de ce que fait la fonction


    Normalement avec ça tes successeurs seront capables de prendre ta suite. Si tes codes sont bien aéré et structuré, ils devraient s'en sortir.
    1. Modérateur
      Je ne parle pas d'une présentation dans le code même, mais dans un document à part, permettant entre autres des schémas.

      Autrement, j'ai effectivement respecté un formalisme le plus clair possible.
    2. Ah bah tu as doxigen ça c'est super, ça te créé un doc html à partir de balise que tu vas mettre dans ton code. Ensuite libre à toi de modifier le html et d'y ajouter des schémas et tout ce que tu voudras.

      http://www.stack.nl/~dimitri/doxygen/
    3. Salut, doxygen est très bien mais je ne pense pas que ça marche avec VBA.
      Selon ce post MzTool fonctionne.
    4. Modérateur
      L'idée n'est pas tant de mettre en forme le programme que de voir les méthodes pour le décrire lisiblement.
      J'ai bien évidemment mon idée sur la question, mais je me dis que le problème n'est pas neufs et que certains ont pu avoir quelques bonnes idées auxquelles je ne pense pas :)