j'ai pour habitude de documenter chacunes de mes méthodes et procédures dans
mes sources, mais est ce nécessaire de documenter le fichier ?
Si oui quelles sont les consignes à suivre ?
Merci.
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est dans un cas où le lecteur de news ou de courrier peut se tromper. Après une recherche rapide, je n'ai pas trouvé de référence, mais des indices en ce sens : c'est comme ça que les URL sont notées dans les RFC relatives à Usenet, et ça semble être le format employé par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté avec quelques logiciels que ça passait beaucoup mieux comme ça.
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un
format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier
correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est
dans un cas où le lecteur de news ou de courrier peut se
tromper. Après une recherche rapide, je n'ai pas trouvé de référence,
mais des indices en ce sens : c'est comme ça que les URL sont notées
dans les RFC relatives à Usenet, et ça semble être le format employé
par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté
avec quelques logiciels que ça passait beaucoup mieux comme ça.
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est dans un cas où le lecteur de news ou de courrier peut se tromper. Après une recherche rapide, je n'ai pas trouvé de référence, mais des indices en ce sens : c'est comme ça que les URL sont notées dans les RFC relatives à Usenet, et ça semble être le format employé par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté avec quelques logiciels que ça passait beaucoup mieux comme ça.
Marc Boyer
In article , Benoît Bréholée wrote:
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est dans un cas où le lecteur de news ou de courrier peut se tromper. Après une recherche rapide, je n'ai pas trouvé de référence, mais des indices en ce sens : c'est comme ça que les URL sont notées dans les RFC relatives à Usenet, et ça semble être le format employé par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté avec quelques logiciels que ça passait beaucoup mieux comme ça.
Si c'est employe sur fr.usenet.usage sans declencher de flame-war, alors ca doit etre le norme :-) Merci,
Marc Boyer -- Lying for having sex or lying for making war? Trust US presidents :-(
In article <873cckcy89.fsf@univ-perp.fr>, Benoît Bréholée wrote:
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un
format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier
correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est
dans un cas où le lecteur de news ou de courrier peut se
tromper. Après une recherche rapide, je n'ai pas trouvé de référence,
mais des indices en ce sens : c'est comme ça que les URL sont notées
dans les RFC relatives à Usenet, et ça semble être le format employé
par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté
avec quelques logiciels que ça passait beaucoup mieux comme ça.
Si c'est employe sur fr.usenet.usage sans declencher de flame-war,
alors ca doit etre le norme :-)
Merci,
Marc Boyer
--
Lying for having sex or lying for making war? Trust US presidents :-(
Mais c'est de l'obfuscation aussi, on ne voit plus où on va. Il y a un format pour les URL : <URL:http://...>. Avec ça un logiciel de courrier correct ne massacre pas les URL de plus d'une ligne.
C'est le format officiel Usenet ?
C'est ce que j'ai toujours vu conseillé comme format, dès qu'on est dans un cas où le lecteur de news ou de courrier peut se tromper. Après une recherche rapide, je n'ai pas trouvé de référence, mais des indices en ce sens : c'est comme ça que les URL sont notées dans les RFC relatives à Usenet, et ça semble être le format employé par les gens de fr.usenet.usages. Et puis j'ai effectivement constaté avec quelques logiciels que ça passait beaucoup mieux comme ça.
Si c'est employe sur fr.usenet.usage sans declencher de flame-war, alors ca doit etre le norme :-) Merci,
Marc Boyer -- Lying for having sex or lying for making war? Trust US presidents :-(
Jean-Marc Molina
Hum voyons si ça fonctionne pour cette URL alors... http://groups.google.fr/groups?hl=fr&lr=&ie=UTF-8&oe=UTF-8&threadm=Xns93F97366D976Aisyfur%40127.0.0.1&rnum=1
... Déjà Outlook Express vient de me la convertir automatiquement, elle est affichée comme un lien hypertexte. Il faut en fait encadrer son URL entre les caractères < et > (par besoin de préfixer l'URL par un URL:, je croyais qu'il fallait le faire), la première fois que j'ai vu ça c'était sur le forum d'ALL HTML (http://www.allhtml.com/forum/index.php), maintenant je commence à comprendre pourquoi. Par contre on peut pas nommer le lien au lieu d'afficher l'URL ? En BBCode par exemple on peut écrire [url="http://www.allhtml.com/forum/index.php"]ALL HTML[/url]. Équivaut à <a href="http://www.allhtml.com/forum/index.php">ALL HTML</a>.
Où peut-on trouver plus d'infos sur ces syntaxes Usenet ?
Merci pour l'astuce, JM
-- Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Hum voyons si ça fonctionne pour cette URL alors...
http://groups.google.fr/groups?hl=fr&lr=&ie=UTF-8&oe=UTF-8&threadm=Xns93F97366D976Aisyfur%40127.0.0.1&rnum=1
... Déjà Outlook Express vient de me la convertir automatiquement, elle est
affichée comme un lien hypertexte.
Il faut en fait encadrer son URL entre les caractères < et > (par besoin de
préfixer l'URL par un URL:, je croyais qu'il fallait le faire), la première
fois que j'ai vu ça c'était sur le forum d'ALL HTML
(http://www.allhtml.com/forum/index.php), maintenant je commence à
comprendre pourquoi. Par contre on peut pas nommer le lien au lieu
d'afficher l'URL ? En BBCode par exemple on peut écrire
[url="http://www.allhtml.com/forum/index.php"]ALL HTML[/url]. Équivaut à <a
href="http://www.allhtml.com/forum/index.php">ALL HTML</a>.
Où peut-on trouver plus d'infos sur ces syntaxes Usenet ?
Merci pour l'astuce,
JM
--
Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Hum voyons si ça fonctionne pour cette URL alors... http://groups.google.fr/groups?hl=fr&lr=&ie=UTF-8&oe=UTF-8&threadm=Xns93F97366D976Aisyfur%40127.0.0.1&rnum=1
... Déjà Outlook Express vient de me la convertir automatiquement, elle est affichée comme un lien hypertexte. Il faut en fait encadrer son URL entre les caractères < et > (par besoin de préfixer l'URL par un URL:, je croyais qu'il fallait le faire), la première fois que j'ai vu ça c'était sur le forum d'ALL HTML (http://www.allhtml.com/forum/index.php), maintenant je commence à comprendre pourquoi. Par contre on peut pas nommer le lien au lieu d'afficher l'URL ? En BBCode par exemple on peut écrire [url="http://www.allhtml.com/forum/index.php"]ALL HTML[/url]. Équivaut à <a href="http://www.allhtml.com/forum/index.php">ALL HTML</a>.
Où peut-on trouver plus d'infos sur ces syntaxes Usenet ?
Merci pour l'astuce, JM
-- Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Jean-Marc Molina
Bonjour,
Quelles sont les limites de JavaDoc selon toi ? Regroupements = sections ?
En tous les cas, ce que je connais de Doxygen me suffit pour faire des documentations. Reste à savoir ce dont vous avez besoin.
JM
-- Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Bonjour,
Quelles sont les limites de JavaDoc selon toi ?
Regroupements = sections ?
En tous les cas, ce que je connais de Doxygen me suffit pour faire des
documentations. Reste à savoir ce dont vous avez besoin.
JM
--
Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Quelles sont les limites de JavaDoc selon toi ? Regroupements = sections ?
En tous les cas, ce que je connais de Doxygen me suffit pour faire des documentations. Reste à savoir ce dont vous avez besoin.
JM
-- Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
kanze
"Jean-Marc Molina" wrote in message news:<bpg2ue$etk$...
Quelles sont les limites de JavaDoc selon toi ? Regroupements = sections ?
Je ne sais pas. Quand je m'en suis servi, il n'y avait pas de sections, à ce que je me souviens.
Les régroupements, c'est l'idée de documenter plusieurs fonctions, etc. apparentées ensemble. En doxygen, par exemple :
//! @name STL Typedef's //! //! The following typedef's are present in order to conform //! with the STL conventions. //@{ typedef Char char_type ; typedef std::basic_string< char_type > string_type ; typedef std::vector< string_type > vector_type ; typedef typename vector_type::value_type value_type ; typedef typename vector_type::reference reference ; typedef typename vector_type::const_reference const_reference ; typedef typename vector_type::difference_type difference_type ; typedef typename vector_type::size_type size_type ; typedef typename vector_type::iterator iterator ; typedef typename vector_type::const_iterator const_iterator ; typedef typename vector_type::reverse_iterator reverse_iterator ; typedef typename vector_type::const_reverse_iterator const_reverse_iterator ; //@}
Je ne me rappelle pas de cette possibilité dans JavaDoc.
-- James Kanze GABI Software mailto: Conseils en informatique orientée objet/ http://www.gabi-soft.fr Beratung in objektorientierter Datenverarbeitung 11 rue de Rambouillet, 78460 Chevreuse, France, +33 (0)1 30 23 45 16
"Jean-Marc Molina" <goa_pasdepourriel_@ifrance.com> wrote in message
news:<bpg2ue$etk$1@news-reader1.wanadoo.fr>...
Quelles sont les limites de JavaDoc selon toi ?
Regroupements = sections ?
Je ne sais pas. Quand je m'en suis servi, il n'y avait pas de sections,
à ce que je me souviens.
Les régroupements, c'est l'idée de documenter plusieurs fonctions, etc.
apparentées ensemble. En doxygen, par exemple :
//! @name STL Typedef's
//!
//! The following typedef's are present in order to conform
//! with the STL conventions.
//@{
typedef Char char_type ;
typedef std::basic_string< char_type > string_type ;
typedef std::vector< string_type > vector_type ;
typedef typename vector_type::value_type value_type ;
typedef typename vector_type::reference reference ;
typedef typename vector_type::const_reference const_reference ;
typedef typename vector_type::difference_type difference_type ;
typedef typename vector_type::size_type size_type ;
typedef typename vector_type::iterator iterator ;
typedef typename vector_type::const_iterator const_iterator ;
typedef typename vector_type::reverse_iterator reverse_iterator ;
typedef typename vector_type::const_reverse_iterator
const_reverse_iterator ;
//@}
Je ne me rappelle pas de cette possibilité dans JavaDoc.
--
James Kanze GABI Software mailto:kanze@gabi-soft.fr
Conseils en informatique orientée objet/ http://www.gabi-soft.fr
Beratung in objektorientierter Datenverarbeitung
11 rue de Rambouillet, 78460 Chevreuse, France, +33 (0)1 30 23 45 16
"Jean-Marc Molina" wrote in message news:<bpg2ue$etk$...
Quelles sont les limites de JavaDoc selon toi ? Regroupements = sections ?
Je ne sais pas. Quand je m'en suis servi, il n'y avait pas de sections, à ce que je me souviens.
Les régroupements, c'est l'idée de documenter plusieurs fonctions, etc. apparentées ensemble. En doxygen, par exemple :
//! @name STL Typedef's //! //! The following typedef's are present in order to conform //! with the STL conventions. //@{ typedef Char char_type ; typedef std::basic_string< char_type > string_type ; typedef std::vector< string_type > vector_type ; typedef typename vector_type::value_type value_type ; typedef typename vector_type::reference reference ; typedef typename vector_type::const_reference const_reference ; typedef typename vector_type::difference_type difference_type ; typedef typename vector_type::size_type size_type ; typedef typename vector_type::iterator iterator ; typedef typename vector_type::const_iterator const_iterator ; typedef typename vector_type::reverse_iterator reverse_iterator ; typedef typename vector_type::const_reverse_iterator const_reverse_iterator ; //@}
Je ne me rappelle pas de cette possibilité dans JavaDoc.
-- James Kanze GABI Software mailto: Conseils en informatique orientée objet/ http://www.gabi-soft.fr Beratung in objektorientierter Datenverarbeitung 11 rue de Rambouillet, 78460 Chevreuse, France, +33 (0)1 30 23 45 16
Jean-Marc Molina
Doxygen a bien évolué depuis. On peut même documenter du PHP et générer des documentations multilingues.
JM
-- Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
Doxygen a bien évolué depuis. On peut même documenter du PHP et générer des
documentations multilingues.
JM
--
Clé AntiPourriel : PASUNPOURRIEL (ne pas retirer)
