Back to all reviewers

Document non-obvious code

Azure/azure-sdk-for-net
Based on 2 comments
Yaml

Add clarifying comments to code elements whose purpose or behavior may not be immediately apparent to other developers. This includes conditional logic blocks, empty configuration properties, and any code structures whose intent requires context to understand.

Documentation Yaml

Reviewer Prompt

Add clarifying comments to code elements whose purpose or behavior may not be immediately apparent to other developers. This includes conditional logic blocks, empty configuration properties, and any code structures whose intent requires context to understand.

For conditional logic:

steps:
  # Restrict the following steps to pull request builds only
  - task: PowerShell@2
    condition: eq(variables['Build.Reason'], 'PullRequest')
    # ... remainder of task

For configuration properties:

directory: specification/liftrmongodb/MongoDB.Atlas.Management
commit: 6a4f32353ce0eb59d33fd785a512cd487b81814f
repo: Azure/azure-rest-api-specs
# Reserved for specifying additional specification directories if needed
additionalDirectories: 

Clear documentation reduces the cognitive load for reviewers and future maintainers, helping them understand the code’s purpose without needing to infer it from implementation details.

2
Comments Analyzed
Yaml
Primary Language
Documentation
Category

Source Discussions