Beware of typeparamref XML documentation tag

Most projects use "Warnings as Errors" project-level setting together with the "XML documentation file" so that you can spot early on which areas of your public APIs are not documented or have broken links etc. in it. I've come to rely on it, especially in the face of refactoring, which even in VS2008 still doesn't refactor code documentation references.

If the refactoring engine can't fix documentation references for me, I want to get compilation errors at least.

Turns out that unlike the paramref and typeparam tags, typeparamref is not validated and will NOT issue warnings when it's out of sync with your codebase (i.e. you renamed a type parameter from a function or type)....

Read full article