domains / families / software-engineering / add-educational-comments

add-educational-comments

separate

Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

When to use

• Adding educational comments to code files
• Explaining programming topics to beginners, intermediate, and advanced users
• Transforming files by adding comments aligned with configuration
• Maintaining file structure, encoding, and build correctness
• Increasing total line count by 125% using educational comments
• Updating existing notes in previously processed files

When not to use

• Altering namespaces, imports, or module declarations in a way that breaks execution
• Introducing syntax errors
• Inserting emojis or special symbols
• Changing file encoding or end-of-line style

Skill page

Source