Comments in C#

Hi there - a few comments on the "comments"....

It would be very nice if code completion existed when typing in the C#
comments. I often have a hard time remembering the exact format of the XML
comments and which attributes can be used.

I know that it can already insert a standard summary section and appropriate
param and returns tags, but when I also want to add a remarks section or an
exception section it becomes harder.

Code completion here would also make it easier for me to "discover" new
comment tags.

Lastly I have noticed that ReSharper is capable of detecting errors in the
cref attribute of the exception comment tag (coool :) - why not expand
this capability so it is capable of detecting whether or not the contents of
a c-tag matches any known class or variable.

Just a thought - I still prefer completion in the comments before the c-tag
thingy.

Kind regards
Thomas Koch
Kapow Technologies



8 comments
Comment actions Permalink

AFAIK provides code completion for doc-comment tags. Unfortunately
ReSharper's code completion disable this. We are going to enable VS code
completion in comments soon.

--
Valentin Kipiatkov
Chief Scientist, Vice President of Product Development
JetBrains, Inc
http://www.jetbrains.com
"Develop with pleasure!"

"Thomas Koch" <thomask_vs@yahoo.dk> wrote in message
news:c7so0f$icu$1@is.intellij.net...

Hi there - a few comments on the "comments"....

>

It would be very nice if code completion existed when typing in the C#
comments. I often have a hard time remembering the exact format of the XML
comments and which attributes can be used.

>

I know that it can already insert a standard summary section and

appropriate

param and returns tags, but when I also want to add a remarks section or

an

exception section it becomes harder.

>

Code completion here would also make it easier for me to "discover" new
comment tags.

>

Lastly I have noticed that ReSharper is capable of detecting errors in the
cref attribute of the exception comment tag (coool :) - why not expand
this capability so it is capable of detecting whether or not the contents

of

a c-tag matches any known class or variable.

>

Just a thought - I still prefer completion in the comments before the

c-tag

thingy.

>

Kind regards
Thomas Koch
Kapow Technologies

>
>
>


0
Comment actions Permalink

Could some one on the ReSharper Development team please provide an update on this issue. I am holding off on purchasing until the Intellisense is re-enabled for XML Commenting. My team uses extensive XML Documentation, and this problem makes it frustrating.

Thanks,
Robbie Coleman

0
Comment actions Permalink

Hi Robbie,

if I understand it correctly, this issue has already been resolved. Now
ReSharper simply invokes
VS.NET completion for tags in XML comments.

"Robbie Coleman" <no_mail@jetbrains.com> wrote in message
news:25696446.1091214324355.JavaMail.itn@is.intellij.net...

Could some one on the ReSharper Development team please provide an update
on this issue. I am holding off on purchasing until the Intellisense is
re-enabled for XML Commenting. My team uses extensive XML Documentation,
and this problem makes it frustrating.

>

Thanks,
Robbie Coleman



0
Comment actions Permalink

I'd like to follow up on this issue too. VS code completion is way too simple in doc-comments. And it doesn't cover all that is required. If R#R team is going to provide good completion in this area, I could provide full list of what I expect. Few simple examples to consider:

1. ndoc supports much more tags than VS and in my work I use many of them
2. When typing "///" on property, VS inserts only summary tag, but ]]> tag is required for complete doc.
3. VS doesn't warn about missing parameter, value on property or return value documentation (CR on this in tracker already exists)
4. QF to convert type/member/etc text in doc comment into cref, paramref, etc

Probably, IDE would be better place to implement good doc support, including some sort of out-of-code doc editor, so we can do it more effectively. Having it in R#R would be cool, though.

0
Comment actions Permalink

Not in the most recent build that I have: 1.0.1 (build 103). I have tested this feature in each build, and it has not been resolved.

When you say "your understanding", do you mean that it is working for you? I'm not trying to be rude at all, I just would like some clarification.

Thanks,
Robbie

0
Comment actions Permalink

Of course, I meant that it works for me - when I type '<' in an XML comment,
and then press Ctrl+Space, VS suggests some tag names depending on the
position inside the comment.
Do you mean something else?

"Robbie Coleman" <no_mail@jetbrains.com> wrote in message
news:18878293.1091462451402.JavaMail.itn@is.intellij.net...

Not in the most recent build that I have: 1.0.1 (build 103). I have tested
this feature in each build, and it has not been resolved.

>

When you say "your understanding", do you mean that it is working for you?
I'm not trying to be rude at all, I just would like some clarification.

>

Thanks,
Robbie



0
Comment actions Permalink

Well Label me loco... ;-}

Dmitry,

I was never even using 'CtrlSpace' unless, say for instance declaring a new varriable. This is because just like when you type an object and period '.', no 'CtrlSpace' is required to display the list of possibilities, when you would type the '<' within the XML comment block, the same functionality applied.

I just tested the 'Ctrl+Space', and feel a bit stupid. It is not that it fails to work, it is just that it's no longer triggered by simply typing '<' anymore.

There is a problem that I (this time really) am sure still exists. I have not received any responses on though
http://www.intellij.net/forums/thread.jsp?forum=35&thread=103554

It is regarding the Reformat feature and what it does to #if()...#endif blocks.

Thanks for following up so promptly!
-Robbie

0
Comment actions Permalink

You are right - ReSharper should not supress autopopup of completion list in cases where it does not handle it. We'll think how to solve this problem.

--
Valentin Kipiatkov
Chief Scientist, Vice President of Product Development
JetBrains, Inc
http://www.jetbrains.com "Develop with pleasure!"


Well Label me loco... ;-}

Dmitry,

I was never even using 'Ctrl+Space' unless, say for instance declaring
a new varriable. This is because just like when you type an object and
period '.', no 'Ctrl+Space' is required to display the list of
possibilities, when you would type the '<' within the XML comment
block, the same functionality applied.

I just tested the 'Ctrl+Space', and feel a bit stupid. It is not that
it fails to work, it is just that it's no longer triggered by simply
typing '<' anymore.

There is a problem that I (this time really) am sure still exists. I
have not received any responses on though

http://www.intellij.net/forums/thread.jsp?forum=35&thread=103554

It is regarding the Reformat feature and what it does to
#if()...#endif blocks.

Thanks for following up so promptly!
-Robbie


0

Please sign in to leave a comment.