Couple of bugs

/// /// /// /// /// /// public delegate int TNotUsed(object x); Removing T will not remove the documentation on T. Severity tiny ///

/// /// /// private static void ParamNotUsed(object to) { return; } Same here Severity tiny /// /// /// /// very very very very very very /// very very very very very very /// very very very very very very /// long desc]]>
private static void ParamNotDoc(object to, object notdoc)
{
return;
}

Automatically adding xml-doc to notdoc will destroy the current documentation on to.
Severity high, breaks code

public class MyClass
{
private readonly MyClass reference;
private bool isNOTReadOnly;

public MyClass()
{
isNOTReadOnly = true;
reference = new MyClass();
reference.isNOTReadOnly = true;
}

public bool IsNOTReadOnly
{
get { return isNOTReadOnly; }
}
}

Reshaper will say that isNOTReadOnly can be made readonly, however that is not the case.
Severity high, breaks code

3 comments
Comment actions Permalink

Personally, I have been using GhostDoc for so long I did not know that RS provided a mechanism to add Xml comments. You might want to try GhostDoc ( http://www.roland-weigelt.de/ghostdoc/ ) and see if you prefer how it handles the issues you raised with RS.

NOTE: I love RS and want to see it provide at least as good support for Xml comments as GhostDoc, but until it does there is no reason not to use GhostDoc.

0
Comment actions Permalink

Hello,

Removing T will not remove the documentation on T.


Currently the context actions, quick fixes and even some refactorings are
not handling XmlDoc properly when removing parameters. :(

Automatically adding xml-doc to notdoc will destroy the current
documentation on to. Severity high, breaks code


Filed http://www.jetbrains.net/jira/browse/RSRP-71127 .

Reshaper will say that isNOTReadOnly can be made readonly, however
that is not the case. Severity high, breaks code


Could not reproduce in R#4, the incorrect suggestion would not appear.

However, the error is still not highlighted if you make it readonly. Filed
http://www.jetbrains.net/jira/browse/RSRP-71126 .

Thanks for reporting the issues.


Serge Baltic
JetBrains, Inc — http://www.jetbrains.com
“Develop with pleasure!”


0
Comment actions Permalink

Hello,

NOTE: I love RS and want to see it provide at least as good support
for Xml comments as GhostDoc, but until it does there is no reason not
to use GhostDoc.


I agree that the current XmlDoc support in R# is of a very basic level (some
analysis rather than real XmlDoc authoring helpers). Hope we'll have a chance
to address this in a future release.


Serge Baltic
JetBrains, Inc — http://www.jetbrains.com
“Develop with pleasure!”


0

Please sign in to leave a comment.