[Ex] AutoitDoc

Partagez vos scripts, et vos applications AutoIt.
Règles du forum
.
Répondre
Avatar du membre
PandiPanda
Membre émérite
Membre émérite
Messages : 656
Enregistré le : mar. 19 juil. 2011 14:03
Localisation : Bruxelles
Status : Hors ligne

[Ex] AutoitDoc

#1

Message par PandiPanda »

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? :shock:
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
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 :lol: )
~ étant donné que je "split" par "@CRLF", les données ne peuvent prendre qu'une ligne. (pour ca que je dit courte description :roll: )

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 :P )
Fichiers joints
AutoitDoc.rar
Voici la version actuelle, comprennant les exemples citée plus haut
(5.76 Kio) Téléchargé 259 fois
Modifié en dernier par PandiPanda le lun. 02 janv. 2012 02:10, modifié 1 fois.
La seule moralité qui tienne dans un monde cruel est la chance. Impartiale. Équitable. Vraie
Avatar du membre
Tlem
Site Admin
Site Admin
Messages : 11773
Enregistré le : ven. 20 juil. 2007 21:00
Localisation : Bordeaux
Status : Hors ligne

Re: [Ex] AutoitDoc

#2

Message par Tlem »

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 !
Thierry

Rechercher sur le forum ----- Les règles du forum
Le "ça ne marche pas" est une conséquence commune découlant de beaucoup trop de raisons potentielles ...

Une idée ne peut pas appartenir à quelqu'un. (Albert Jacquard) tiré du documentaire "Copié n'est pas volé".
Avatar du membre
PandiPanda
Membre émérite
Membre émérite
Messages : 656
Enregistré le : mar. 19 juil. 2011 14:03
Localisation : Bruxelles
Status : Hors ligne

Re: [Ex] AutoitDoc

#3

Message par PandiPanda »

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é?
La seule moralité qui tienne dans un monde cruel est la chance. Impartiale. Équitable. Vraie
Avatar du membre
Tlem
Site Admin
Site Admin
Messages : 11773
Enregistré le : ven. 20 juil. 2007 21:00
Localisation : Bordeaux
Status : Hors ligne

Re: [Ex] AutoitDoc

#4

Message par Tlem »

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

Rechercher sur le forum ----- Les règles du forum
Le "ça ne marche pas" est une conséquence commune découlant de beaucoup trop de raisons potentielles ...

Une idée ne peut pas appartenir à quelqu'un. (Albert Jacquard) tiré du documentaire "Copié n'est pas volé".
Alex74
Niveau 4
Niveau 4
Messages : 73
Enregistré le : ven. 15 avr. 2011 15:24
Status : Hors ligne

Re: [Ex] AutoitDoc

#5

Message par Alex74 »

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 :)
Avatar du membre
PandiPanda
Membre émérite
Membre émérite
Messages : 656
Enregistré le : mar. 19 juil. 2011 14:03
Localisation : Bruxelles
Status : Hors ligne

Re: [Ex] AutoitDoc

#6

Message par PandiPanda »

@Alex74
à vrai dire je fais tellement de fonction, que ca me permettrai d'avoir une meilleur "visibilité" :mrgreen: , 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)"
La seule moralité qui tienne dans un monde cruel est la chance. Impartiale. Équitable. Vraie
Avatar du membre
Tlem
Site Admin
Site Admin
Messages : 11773
Enregistré le : ven. 20 juil. 2007 21:00
Localisation : Bordeaux
Status : Hors ligne

Re: [Ex] AutoitDoc

#7

Message par Tlem »

@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. ;)
Thierry

Rechercher sur le forum ----- Les règles du forum
Le "ça ne marche pas" est une conséquence commune découlant de beaucoup trop de raisons potentielles ...

Une idée ne peut pas appartenir à quelqu'un. (Albert Jacquard) tiré du documentaire "Copié n'est pas volé".
Avatar du membre
PandiPanda
Membre émérite
Membre émérite
Messages : 656
Enregistré le : mar. 19 juil. 2011 14:03
Localisation : Bruxelles
Status : Hors ligne

Re: [Ex] AutoitDoc

#8

Message par PandiPanda »

Merci bien, j'ai de quoi analyser maintenant :mrgreen:
La seule moralité qui tienne dans un monde cruel est la chance. Impartiale. Équitable. Vraie
Répondre