Opensim : Ecrire de la doc, encore et encore.

Publié le 26 Juin 2008

Je le dit assez souvent : "Avant d'écrire du code, petit scarabé, tu vas écrire de la doc".
C'est valable aussi pour moi-même ;)

Je m'attaque à la documentation du code opensim, et c'est pas une mince affaire !!
  • - Comprendre le code (et c'est pas toujours joli-joli)
  • - Verifier que la doc déjà écrite correspond au code actuel.
  • - La moifier au besoin.
  • - Ecrire la doc encore non écrite.
  • - Vérifier que la deoc qu'on viens d'écrire correspond bien au code.
  • - Rajouter eventuellement les tags appropriés sur les méthodes pas encore implentée, non-fonctionelle, ou depreciée. Et c'est loin d'etre une mince affaire de savoir si une partie de code est dépreciée.
  • - Générer la documentation, verifier qu'il n'y a pas d'erreur dans le format de documentation utilisé (Standard ECMA-334, Annex E.dans le cas d'opensim)
  • - Une fois que tout est ok.
  • - faire un dernier svn update. Resoudre les eventuels conflits avec la derniere revision
  • - soumettre le patch
  • - Attendre en priant de ne pas avoir écris une grosse bourde dans le patch.
  • ...
  • - Recommencer avec un autre bloc de code.

Pour l'instant j'ai documenté une infime partie du code opensim.
J'en suis déjà environ 1800 lignes de patch, y'en a autant en cours d'ecriture, que je soumetrai surement demain.
Au total, si j'ai le courage de tout faire (j'en doute), ca sera plusieurs dizaines de milliers de lignes de patch.

Allez... courage !! ;)

Rédigé par kerunix Flan

Publié dans #Secondlife

Repost0
Pour être informé des derniers articles, inscrivez vous :