[263] doc comment issues

Hi,

R# is showing some document comments that are valid as a warning:

1. the "T:ClassWithinThisNameSpace" syntax is not supported
2. the required in generic types < and > are marked as syntax errors
3. types with 'type parameter overloading', (classes only differing by
the amount of type parameters) are marked as "ambigous reference"

/// /// Initializes a new instance of the class. /// ]]>
public GenericTreeNodeList()
: base()
{
}

Best Regards,

Wiebe Tijsma

2 comments
Comment actions Permalink

Some tips:

  • If you use T: and other constructs, the C# compiler will NOT verify the

syntax, so don't use them.
(see
ms-help://MS.MSDNQTR.v80.en/MS.MSDN.v80/MS.VisualStudio.v80.en/dv_csref/html/60c71193-9dac-4cd3-98c5-100bd0edcc42.htm)

  • If you use these constructs, you have to use fully qualified names, (see

help link above).

(* Thus: if you use Ghostdoc, change the config of it. This is a conformed
error in Ghostdoc)

  • Use for generics, not < and >. This is more readable.


Regards,
Erwin

"Wiebe Tijsma" <wiebeREMOVE@CAPITALStijsma.com> schreef in bericht
news:eh80tq$rhd$1@is.intellij.net...

Hi,

>

R

  1. is showing some document comments that are valid as a warning:

>

1. the "T:ClassWithinThisNameSpace" syntax is not supported
2. the required in generic types &lt; and &gt; are marked as syntax errors
3. types with 'type parameter overloading', (classes only differing by the
amount of type parameters) are marked as "ambigous reference"

>

/// <summary>
/// Initializes a new instance of the <see
/// cref="T:GenericTreeNodeList&lt;TId, TItem&gt;"/> class.
/// </summary>
public GenericTreeNodeList()
: base()
{
}

>

Best Regards,

>

Wiebe Tijsma



0
Comment actions Permalink

Thanks Erwin!

Erwin Derksen wrote:

Some tips:

  • If you use T: and other constructs, the C# compiler will NOT verify the

syntax, so don't use them.
(see
ms-help://MS.MSDNQTR.v80.en/MS.MSDN.v80/MS.VisualStudio.v80.en/dv_csref/html/60c71193-9dac-4cd3-98c5-100bd0edcc42.htm)

  • If you use these constructs, you have to use fully qualified names, (see

help link above).

(* Thus: if you use Ghostdoc, change the config of it. This is a conformed
error in Ghostdoc)

  • Use for generics, not &lt; and &gt;. This is more readable.


Regards,
Erwin

"Wiebe Tijsma" <wiebeREMOVE@CAPITALStijsma.com> schreef in bericht
news:eh80tq$rhd$1@is.intellij.net...

>>Hi,
>>
>>R# is showing some document comments that are valid as a warning:
>>
>>1. the "T:ClassWithinThisNameSpace" syntax is not supported
>>2. the required in generic types &lt; and &gt; are marked as syntax errors
>>3. types with 'type parameter overloading', (classes only differing by the
>>amount of type parameters) are marked as "ambigous reference"
>>
>>/// >>/// Initializes a new instance of the >/// cref="T:GenericTreeNodeList<TId, TItem>"/> class. >>/// >> public GenericTreeNodeList() >> : base() >> { >> } >> >>Best Regards, >> >>]]>Wiebe Tijsma


0

Please sign in to leave a comment.