abzfarah / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Rename #@+/#@- meta-tags with clearer, more intuitive names #206

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
The functionality provided by these meta tags is really useful.  But I can
never remember the exact set of characters required.  I'm always typing
"/**@#+", or "/**@-" or whatever.

After pondering this for a while I think I see the logic - "@+" and "@-" as
tag names, with "#" to indicate meta tags - but the end result is still
confusing.  When this is documented simply as, "Use this string to start a
section, and end with this one", it's just not clear or easy to remember
what these tokens are.

My suggestion is to change these to "@@group" and "@@ungroup".  The "@@" is
a more intuitive as a "meta" tag ("#" implies a count of some sort), and
"group"/"ungroup" are more explicit about what the tags do.

Original issue reported on code.google.com by broofa on 22 Feb 2009 at 2:13

GoogleCodeExporter commented 8 years ago
The current syntax was suggested by a user based on an existing standard (from 
phpdoc). Since this was 
already discussed and agreed to via the user group, I'm not keen to summarily 
change the syntax without at 
least starting a new discussion about the issue.

For background read this:
http://code.google.com/p/jsdoc-toolkit/issues/detail?id=58

If you want to continue, please invite the user group to join in first, 
particularly those who were part of the 
original discussion.

Original comment by micmath on 15 Jun 2009 at 4:25