Back to all reviewers

Document configuration intent

dotnet/runtime
Based on 6 comments
Other

Configuration settings should be self-documenting with clear intent. When adding temporary workarounds, conditional flags, or platform-specific settings, include descriptive comments explaining their purpose, limitations, and lifecycle. Use TODO comments with issue references for temporary configurations, and choose clear, descriptive names for all...

Configurations Other

Reviewer Prompt

Configuration settings should be self-documenting with clear intent. When adding temporary workarounds, conditional flags, or platform-specific settings, include descriptive comments explaining their purpose, limitations, and lifecycle. Use TODO comments with issue references for temporary configurations, and choose clear, descriptive names for all configuration properties. This practice helps future developers understand why certain configurations exist and when they can be modified or removed.

Examples:

  1. For temporary workarounds: ```xml
<_Crossgen2Supported Condition="'$(TargetOS)' != 'illumos' and '$(TargetOS)' != 'solaris'">true

2. For feature flags with specific scope:
```xml
<FeatureJavaMarshal Condition="'$(Configuration)' == 'Debug' or '$(Configuration)' == 'Checked' or '$(TargetOS)' == 'Android'">true</FeatureJavaMarshal>
  1. For clear, descriptive naming: ```xml
true true

```

6
Comments Analyzed
Other
Primary Language
Configurations
Category

Source Discussions