AutoIt Français

Bonjour,
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)
Et voici le resultat apres utilisation de AutoitDoc:
_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 )

Dommage de ne pas ré-utiliser l'existant.
La doc AutoIt est basée sur un script de mise en forme comme celui que vous ré-inventez. Personnellement, je n'y aucun inconvénient, mais c'est quand même dommage de passer du temps la dessus !

Pour la simple et bonne raison que j'ai cherché mais pas trouvé cette "utilitaire"
Sinon oui j'aurai pu avoir une bonne base pour débuté, ou y faire mes propre changements , sans avoir cette masse de travail :p

auriez vous un lien, ou un nom? ou pourrais je le trouvé?

Si je ne m'abuse, c'est inclus dans les sources de la doc.
http://www.autoitscript.com/autoit3/fil ... ve/autoit/

J'ai testé, c'est sympa. J'avais jamais vraiment pensé à faire une doc pour mes fonctions.
Par contre, dans votre message précédent, vous avez oublié de préciser le nom de la macro pour remplir les remarques qui est sans surprise @remark

@Alex74
à vrai dire je fais tellement de fonction, que ca me permettrai d'avoir une meilleur "visibilité" , sans oublier de la portabilité !
merci, je vais modifier tout de suite

@Tlem
J'ai parcouru le zip _build.zip, avec les 3 fichier "CompileLib,FTP,OutputLib" sans trouvé aucune trace de ce que je veux , j'ai ensuite parcouru "autoit-v3.0.100.zip" sans trouvé aucune trace, mais simplement le fichier "AutoIt" qui est le "Fichier HTML compilé (.chm)"

@PandiPanda
Pour éviter que vous ne cherchiez trop longtemps :

Téléchargez le fichier de la doc : http://www.autoitscript.com/autoit3/fil ... .0-src.exe
Téléchargez le fichier des includes pour la construction des fichiers txt=> html : http://www.autoitscript.com/autoit3/fil ... _build.zip

Décompressez la doc et faite la même chose avec le fichier _build à extraire à la racine du dossier de la doc.

Ensuite rendez-vous dans le sous dossier autoit-docs-v3.3.8.0-src\docs\autoit\english ou vous trouverez les scripts de lancement de la construction All_xxxx.au3.

Merci bien, j'ai de quoi analyser maintenant