Back to all reviewers

Document maintenance decisions

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

Add clear documentation for any decisions that affect future code maintenance. This includes: 1. Providing explanatory comments for non-obvious default values in parameters

Documentation Other

Reviewer Prompt

Add clear documentation for any decisions that affect future code maintenance. This includes:

  1. Providing explanatory comments for non-obvious default values in parameters
  2. Recording version updates in the CHANGELOG
  3. Following established documentation structures and patterns

For example, when defining parameters with default values:

[string]$RunDirectory = (Resolve-Path "${PSScriptRoot}/../../../"),  # Default points to repo root for consistent script execution

This documentation practice improves maintainability by ensuring that future developers understand the reasoning behind specific implementation choices, reducing the learning curve and helping to prevent unintended side effects during code modifications.

2
Comments Analyzed
Other
Primary Language
Documentation
Category

Source Discussions