Velt Comments Best Practices

What it does

This skill provides guidance and best practices for writing effective comments in Velt.js code, ensuring clarity, maintainability, and collaboration within development teams. It helps users understand the importance of well-documented code and offers practical advice on how to achieve it. The skill aims to improve code quality by promoting consistent commenting standards.

When to use it

• You're new to Velt.js and want to learn how to properly comment your code.
• Your team is struggling with inconsistent commenting styles, leading to confusion.
• You need help understanding why certain comments are more effective than others.
• You’re refactoring existing Velt.js code and want to improve its documentation.

Key capabilities

• Provides guidelines for writing clear and concise comments.
• Offers advice on when to comment, and what information to include.
• Promotes consistent commenting standards within a development team.
• Helps ensure maintainability of Velt.js codebases.

Example prompts

• "What are the best practices for commenting a Velt component?"
• "How should I document a complex function in Velt.js?"
• “Explain how to write effective JSDoc comments for my Velt hooks.”

Tips & gotchas

This skill assumes some basic familiarity with Velt.js syntax and concepts. While it provides guidance, understanding the underlying code is still crucial for writing meaningful and relevant comments.