assistance-engine/docs/developer.avapframework.com/chapter7_5.md

3.4 Best Practices

When using comments in AVAP™, it is important to follow some best practices:

• Use comments moderately and only when necessary to clarify the code.
• Keep comments updated as the code evolves.
• Write clear and concise comments that are easy for other developers to understand.
• Avoid redundant or unnecessary comments that do not provide useful information to the reader.