dotnet / dotnet/winforms

[Tracking] The repo needs clear rules for use of "see cref" and "see langword" attributes

Open
#12,186 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.9k
Forks
1.1k
Avg merge
1d 13m
Merged PRs (30d)
85

Description

Inconsistent use of the "see cref" attribute.
1. It is used for every occurrence where it could be used (all places VS has a code fix), including summary and return/value sections. This really clutters the documentation.
3. It is used once in summary and not in return/value where it could be used also.
4. It is used in return/value but not in summary where it could be.
5. It is not used at all typically where the target is not fully qualified, so VS will not offer a CodeFix but there are also times it will and it isn't used.

Inconsistent use of the "see langword" attribute.
1. It is seldomly used where it could be. true/True, false/False, null/Nothing, Property, Event, I don't know the full list but the CodeFix does.

Guideline would be great; I am not suggesting anyone has to go back and fix everything especially without a CodeAnalyzer (unless it was standalone it would be horribly slow and would produce too may incorrect results) but as code is touched it would be nice to have consistent rules.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.