[resolu]Commentaires javascript : caractères spécifiques

bonsoir ,

depuis longtemps je vois dans les commentaires javascripts et particulièrement
en début de script une 'mise en commentaire ainsi :

/**
 * commentaires
 */

avec quelques spécificités et "harmonies"

/**
 * @author kzone
 */

Est-ce que certains navigateurs utilisent ces commentaires (comme il est possible en langage Java) ou bien est-ce juste (sont-ce !?) des commentaires bien de chez javascript !?

Ps: j'suis en surcharge termique ; il fait encore 28° à minuit , alors ...soyez indulgent si c'est vraiment une question à perdre des kiwiS
Modifié par kzone (28 Aug 2007 - 09:04)

Bonsoir kzône,

/* début
commentaires sur plusieurs lignes utilisable aussi pour du code CSS, et probablement d'autres langages de programmation.

fin */

mais peut-être n'ai-je pas compris ta question

Salut ,

/*
Ça marche aussi avec PHP [langue] !
*/

Si c'était ça ta question, à ma connaissance il n'existe pas d'outil similaire officiel à la javadoc pour le javascript, mais il est possible de créer ce genre de doc en php.

Par exemple, j'ai mis quelques bibliothèques de fonctions sur mon site, et la doc est crée automatiquement par un script php en recherchant ce genre de commentaire et tags. C'est pas aussi complet que la javadoc, mais pour moi ça me suffit largement.

bonjour à tous ,

je me suis posé cette question , parce que certain éditeur de texte génère
automatiquement de tel commentaire @author, @last-modified ...blablabla
(comme mon éditeur Aptana intégré a Eclipse)

et que j'en trouve dans des script Js (bien entendu j'en ai pas trouvé un seul cette nuit pour corroborer mes dires ...) !
Et les doubles astérisques m'ont fait chercher une réponse ...

Bon comme d'habitude , je pose mal mes questions
Par contre , merci QuentinC je vais aller regarder tes bibliothèques ( je les ais pas vu celle-là ).
Ps: j'en profite pour te dire que je n'arrive pas à m'inscrire sur ton forum , car le sujet concernant Java et l'accessibilité des classes Swing m'interesse (toujours rapport au Svg héhé )

Donc ce ne sont que de simples commentaires sans magie dissimulée

Re PS : je viens de lire d'ailleur que l'on peut également utilisé les commentaires 'type Html' <!--dans un code javascript --> ....
M'enfin çà confusse le tout
Modifié par kzone (28 Aug 2007 - 09:03)

Hello !

Je sais que le code source de YUI est parsemé de documentaires de ce genre. Peut-être qu'ils proposent un outil similaire à la JavaDoc ?

kzone a écrit :
Re PS : je viens de lire d'ailleur que l'on peut également utilisé les commentaires 'type Html' <!--dans un code javascript -->

Non.

a écrit :

Ps: j'en profite pour te dire que je n'arrive pas à m'inscrire sur ton forum , car le sujet concernant Java et l'accessibilité des classes Swing m'interesse
(toujours rapport au Svg héhé

Comment ça tu n'arrives pas à t'inscrire à mon forum ? A quel moment est-ce que tu es bloqué ? Que je puisse arranger ça rapidement si besoin.
Envoie-moi un MP si tu penses que c'est mieux.

julien Royer a écrit :

Non.

si

Enfin ce qu'en dit Jeremy Keith dans le bouquin "DomScripting"

a écrit :

You can also use HTMl-style comments, but only for single lines.
<!-- this comment in javascript
In Html you would need to close the comment with -->
<!-- this is a comment in Html -->
Javascript would simply ignore the closing of the comment, treating it as a part of the comment itself.

Par ailleurs plus loin il en déconseille l'utilisation

QuentinC a écrit :

Comment ça tu n'arrives pas à t'inscrire à mon forum ? A quel moment est-ce que tu es bloqué ? Que je puisse arranger ça rapidement si besoin.
Envoie-moi un MP si tu penses que c'est mieux.

ok , mais je fera cela ce soir , sinon je vais être en retard au boulot
Modifié par kzone (28 Aug 2007 - 11:37)

kzone a écrit :
si

En tout cas, c'est totalement absent de la norme EcmaScript, donc si c'est possible, c'est uniquement à cause de la tolérance de certains navigateurs.

a écrit :

si c'est possible, c'est uniquement à cause de la tolérance de certains navigateurs.

+1 et voici l'explication : du temps que javascript était tout nouveau, les codeurs avaient pris l'habitude d'encadrer leur code par un commentaire HTML pour empêcher que les navigateurs un peu plus anciens ne connaissant pas encore la balise <script> n'affichent le code source js directement dans le flux normal de la page. La politique de base du HTML de dire balise inconnue = balise ignorée provoque ce comportement complètement stupide mais logique.
Depuis, cette habitude est restée.... elle peut être encore utile pour lynx ou un petit navigateur en console par exemple.
Du coup, une ligne commençant par <!-- ou par --> est totalement ignorée. Par contre effectivement ça ne marche pas pour des commentaires à plusieurs lignes.

EDIT : kzone 
, pour mon forum, j'ai créé un compte bidon cet après-midi, ça fonctionne. Dis-moi si tu as encore des problèmes mais normalement ça marche.
Modifié par QuentinC (28 Aug 2007 - 13:41)

Salut,

Juste pour info... (J'arrive un peu tard mais mieux vaut tard que jamais ) ... Il existe jsdoc (C'est l'outil dont se sert Yahoo pour sa librairie) et phpdoc pour ce qui est des scripts php. Ces deux outils sont les équivalents de javadoc.

A voir leur exemple c'est exactement le même format de page HTML qui est produit.
Merci, ben si jamais je saurai que ça existe.

Pour le moment, il faut dire que je n'ai pas fait beaucoup de POO avancée ni en javascript ni en php.... pour l'instant je fais de la POO seulement en Java et un peu en C++ (je me suis mis que très récemment au C++).

ah ben oui cela explique ce que je soupçonnais

merci pour les liens !!

QuentinC a écrit :

je me suis mis que très récemment au C++

Faut que je m'y mette aussi , vu que c'est le langage que l'on va utiliser en DUT informatique (je vais retrouver mes 20 ans )

@QuentinC : j'ai a nouveau tenté de m'inscrire sur le forum mais il m'est indiqué que le peudo 'kzone' est déjà utilisé (il ne fait paourtant pas partie de la liste) ; c'est le peuso que j'ai utilisé sur le livre d'or
Modifié par kzone (03 Sep 2007 - 19:54)

kzone a écrit :

@QuentinC : j'ai a nouveau tenté de m'inscrire sur le forum mais il m'est indiqué que le peudo 'kzone' est déjà utilisé (il ne fait paourtant pas partie
de la liste) ; c'est le peuso que j'ai utilisé sur le livre d'or

Je t'ai créé ton compte manuellement, je t'envoie un MP avec identifiant et mot de passe.
IL n'y a pas de vérification de pseudo dans le livre d'or.

merci , je ne vois pas d'où peut venir cette 'confusion' de pseudo