Re: [Dtddoc-develop] Correct form of doc comments?

[Stefan C. <sch...@sk...>]

>> To me, "<!---" is a bug in Netbeans.
>> Now, if you think it would be useful to distinguish normal DTD =20
>> comment from
>> DTDDoc comments (just like javadoc doesn't render basic comments), =20=

>> perhaps we
>> can add it to DTDDoc's feature list, as an Ant task option
>
> Whatever you think best, I guess.  I didn't find it unexpected for =20
> the doc comments to be different to the ordinary ones since that's =20
> what I was used to from javadoc.  On the other hand, if you don't =20
> want to change it I can just as easily raise a bug report with =20
> Netbeans.

Dunno exactly if a bug submission to NetBean would solve anything... =20
I guess we're more agile.

>
>> (name to find : if
>> you have an idea of a meaningful name...).
>
> Hmm...  docCommentDelimiters=3D"true", perhaps?

docCommentDelimiter=3D"triple-hyphen" or "none"

I suggest this because "true" makes sense only if you know the =20
meaning behind "docCommentDelimiter". IMHO, my suggestion is more =20
readable for someone who doesn't RTFM...

Does this make sense ?

stF



>
>
> Andrew.
>
>>
>> Herv=E9
>>
>> Le Vendredi 14 Juillet 2006 11:56, Andrew Stevens a =E9crit :
>> > I stumbled across DTDDoc because a DTD I generated in Netbeans =20
>> (from an
>> > existing XML document) contained a whole load of comments which =20
>> read
>> > <!--- Put your DTDDoc comment here. -->
>> > by each element or attribute declaration.  Nice tool :-)
>> >
>> > However, I noticed that the generated docs all have a leading =20
>> "-", which I
>> > assume is because the comments Netbeans generated use =20
>> "<!---" (in the same
>> > way that javadoc comments use "/**" rather than just "/*") and =20
>> DTDDoc is
>> > expecting just "<!--".  So I'm wondering whether this has always =20=

>> been the
>> > case, or the Netbeans module is simply doing it wrong, or if =20
>> I've found the
>> > wrong tool and there's another DTDDoc that expects the other form?
>> >
>> >
>> > Andrew.
>
>
>
> ----------------------------------------------------------------------=20=

> ---
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to =20
> share your
> opinions on IT & business topics through brief surveys -- and earn =20
> cash
> http://www.techsay.com/default.php?=20
> page=3Djoin.php&p=3Dsourceforge&CID=3DDEVDEV____________________________=
____=20
> _______________
> Dtddoc-develop mailing list
> Dtd...@li...
> https://lists.sourceforge.net/lists/listinfo/dtddoc-develop