project-conventions

Every code need inline doc comments.

⭐0stars🔀0forks📁View on GitHub🕐Updated Jan 4, 2026⬇️2downloads

When & Why to Use This Skill

This Claude skill automates the process of adding professional inline documentation to source code, ensuring adherence to programming best practices. By intelligently generating language-specific comments—such as Javadoc for Java, docstrings for Python, and XML comments for C#—it significantly enhances code readability, facilitates easier maintenance, and helps development teams uphold consistent project conventions and style guides.

Use Cases

  • Standardizing Documentation: Automatically apply uniform docstring formats across a multi-language repository to ensure all contributors follow the same project conventions.
  • Legacy Code Maintenance: Generate explanatory comments for complex, undocumented legacy functions to simplify future debugging and reduce the learning curve for new developers.
  • Technical Debt Reduction: Improve code quality by adding detailed inline notes to intricate algorithms or 'hacky' code blocks, making future refactoring safer and more efficient.
  • Pre-Review Preparation: Use the skill to populate documentation headers for classes and methods before submitting code for peer review, ensuring compliance with organizational quality standards.
nameproject-conventions
descriptionEvery code need inline doc comments.

Instructions

Add inline documentation comments to the code following best practices for the programming language used. Ensure that all functions, classes, and significant code blocks are well-documented to enhance readability and maintainability. Use appropriate documentation styles such as Javadoc for Java, docstrings for Python, or XML comments for C#.