ASDoc - Liste des balises <html>
| Balise | Description |
|---|---|
| <p> |
Commence un nouveau paragraphe. N’oubliez pas de fermer la balise par </p>
N’utilisez pas <p> pour le premier paragraphe de votre commentaire, car celui ci est la description principale de votre élément. Exemple: /** * Ceci est la description principale. * * <p>Ceci est un nouveau paragraphe.</p> * * <p>Ceci est un 3ème paragraphe.</p> */
ASDoc ignore les espaces et les retours ligne, donc, pour que le commentaire soit plus lisible dans le fichier .as, ajoutez juste une ligne vide. |
| class=”hide” |
Cache le text qui suit dans dans la génération de doc. Utile pour commenter du code sans que celà apparaisse dans la documentation. |
| <listing> |
Commence un listing de programme. (Bloc de code)
Est utiliser pour inserer un exemple de code dans la documentation. N’oubliez pas de fermer la balise </listing> |
| <pre> |
Formate le texte tel qu’il est entré, sans devoir utiliser <br> et ce genre de chose.
Pour des exemples de code, utilisez <listing>. |
| <br> |
Ajoute un retour ligne. N’oubliez pas de femer la balise par </br>
Pour ajouter une ligne vide, il est préférable d’utiliser un nouveau paragraphe <p> Cette balise va disparaître dans le futur, essayez de ne pas l’utiliser. |
| <ul>, <li> |
Crée une liste, n’oubliez pas de fermer les balises </ul></li> |
| <table>
<th>
|
Crée un tableau. Pour un style de base conforme à ASDoc, dénissez l’atrribut de classe à “innertable”. Evitez les éléments structurels tels que les listes à l’intérieur d’un tableau.
Asdoc utilise un CSS standard qui contient les définitions <table>,<th>,<tr> et <td>. N’oubliez pas de fermer vos balises.
Utilisez <th> pour créer des entêtes au lieu de <td>, afin d’obtenir un formatage correct. |
| <img> |
Insert une image. Pour obtenir un espace autour de l’image, placez la dans une balise <p>. Si vous utilisez une légende, elle sera en gras.
N’oubliez aps de fermer la balise par /> |
| <code> |
Applique une police monospace. N’oubliez pas de fermer la balise. |
| <strong> |
Formatte le texte en gras. N’oubliez pas de fermer la balise. |
| <em> |
Formatte en italique. N’oubliez pas de fermer la balise. </em> |
| < |
A utiliser à la place de du caractère < . Le ; de terminaison est obligatoire. |
| > |
A utiliser à la place de du caractère > . Le ; de terminaison est obligatoire. |
| & |
A utiliser à la place de du caractère & . Le ; de terminaison est obligatoire. |
| ~~ |
A utiliser à la place de du caractère * . |
| — |
A utiliser à la place de du caractère - . Le ; de terminaison est obligatoire. |
| ™ |
A utiliser à la place de du caractère ™ . Le ; de terminaison est obligatoire. |
|   |
A utiliser à la place de du caractère de passage à la ligne sans Enter: ”Line Feed ”. Le ; de terminaison est obligatoire. |
| ® |
A utiliser à la place de du caractère ® . Le ; de terminaison est obligatoire. |
| ° |
A utiliser à la place de du caractère degré °. Le ; de terminaison est obligatoire. |
| @ | A utiliser à la place de du caractère @. Le ; de terminaison est obligatoire. |