I was just watching Allan's latest screencast and wanted to add support for some of the techniques used in block comments. However, I noticed that the Javadoc blocks are scoped with comment.documentation.java. I probably created it that way, but it seems like it should really be "comment.block.documentation.java".
/* * this is a block comment */
/** * this is a javadoc block comment */
I could scope the snippets for comment.block and comment.documentation, but I still think the latter should extend from the former. Is this the desired scope for those types of doc comments, or was this overlooked?
-- Brian Lalor blalor@bravo5.org
On 21/4/2006, at 20:35, Brian Lalor wrote:
[...] I could scope the snippets for comment.block and comment.documentation, but I still think the latter should extend from the former. Is this the desired scope for those types of doc comments, or was this overlooked?
comment.documentation, I think, is used in a few languages where there are comment directives sort of intended for documentation.
An example of that would be Ruby/Perl’s =begin/=end lines.
So if /** … **/ is de facto for javadoc, it might be appropriate to keep it as comment.documentation.
That said, I am not aware of anything which makes use of the scope, but it could e.g. be useful to have spell checking enabled only in documentation comments (as regular comments are often used to comment out code).
On Apr 21, 2006, at 7:56 PM, Allan Odgaard wrote:
So if /** … **/ is de facto for javadoc, it might be appropriate to keep it as comment.documentation.
It's /** … */, actually. :-)
That said, I am not aware of anything which makes use of the scope, but it could e.g. be useful to have spell checking enabled only in documentation comments (as regular comments are often used to comment out code).
It's not a big deal, I suppose. I see where this relationship wouldn't apply to other languages, and it's not a huge problem to specify both scopes for those snippets.
-- Brian Lalor / blalor@bravo5.org
"[Pickup trucks] are, to the world of cars, what Mexican food is to the world of cuisine. They exist, they are popular in Texas, and, er, that’s it." -- Jeremy Clarkson
-
Allan Odgaard -
Brian Lalor