To Comment or Not To Comment

This presentation summarizes my understanding of best practices for code comments in software development.

The slides can be seen at: https://www.indrapatil.com/to-comment-or-not/

Development

This project uses Python 3.14 (see .python-version) with uv for dependency management, Quarto for rendering slides, and just as a command runner.

Prerequisites

# Install just (macOS)
brew install just

Setup

just install

Just Commands

just help     # Show all available commands
just install  # Install Python dependencies
just update   # Update Python dependencies
just render   # Render slides to HTML
just preview  # Start a live preview with auto-reload
just open     # Alias for preview (live-reload dev server over localhost)
just clean    # Remove generated files and caches
just check    # Check the Quarto and Python setup
just          # Install dependencies and start live-reload preview

Feedback

Feedback and suggestions are welcome in the issue tracker.