c# - Document method-summary with ambigious reference -


i have massively overloaded method methoda referenced summary-tag within documentation of methodb:

/// <summary>a link <see cref="methoda" /></summary> void methodb { ... } 

the comment should not rely special overload of methoda of them. compiler prints ammessage cref-attribute ambigious (which intended). there best practices solve issue? thought of remove see-tag summary. maybe have other approaches?

i think have 2 options. either refer specific method in comment:

/// <summary>a link <see cref="methoda(int)" /> or 1 of it's overloaded variants</summary> 

alternatively, can add m: prefix remove error though may not quite require:

/// <summary>a link <see cref="m:methoda" /></summary> 

Comments

Popular posts from this blog

html - height not adding height to a empty div -

Oracle SQL. How to select specific IDs where value of columns specify criteria? -

python - Robot Framework location and name of keyword -