Voici un script en cours de développement, qui permet de créer une documentation (au format html) très facilement !
Tout d'abord comment cela fonctionne t'il?
Pour pouvoir utilisez AutoitDoc, vous devez préalablement "formater" votre fichier .au3.
Formater? c'est à dire?
Ne vous inquiéter pas, aucune conversion, ou autre bidouillage ne sera nécessaire, simplement il faudra suivre une certaine mise en forme, procédure !
Je vous met ce dessous 2 exemple de mise en forme ; (ces codes sont disponible dans le fichier .rar)
► Afficher le texte
► Afficher le texte
_Division() et _Somme()
Dans cette version actuelle (et je l'avoue un peu bordelique ...) Il y'a actuellement 5 "macro". à savoir:
- @desc : qui permet une description courte de la fonction
~~~> utilisation: @desc <courteDescription>
- @param : qui est un des parametre de la fonction, ainsi que ca description courte
~~~> utilisation: @param <maVar> <mADescription>
- @return : qui est la valeur de retour séparé par un |
~~~> utilisation: @return <valeurSiReussi>|<valeurSiRater>
- @ex : qui permet l'ajout d'un exemple
~~~> utilisation: @ex <PathFichierExemple>(DOIT ETRE FULL le path, pas de @scriptdir,...)
- @remark : qui permet d'ajouter une remarque quelconque
~~~> utilisation: @remark <maRemarque>
De plus, il faut entourer le tout de #cs AutoitDoc <nomFunc>
et de #ce
Bug actuel:
~ certain caractere
~ mise en forme (notamment pour la partie exemple)
~ code a remanié, des choses en "surplus", difficile à lire, sans oublier que c'est bordelique
~ si vous en voyez ... (j'en ai sans doute oublié tout plein )
~ étant donné que je "split" par "@CRLF", les données ne peuvent prendre qu'une ligne. (pour ca que je dit courte description )
A venir:
~ Coloration syntaxique pour "l'exemple"
~ possibilité de faire des "Liens"
~ ajout de macro
~ un meilleur parseur, code général
~ choix de couleur (meme si jaime bien actuellement )