KiT-Maverik/AI prompt for generating React component description.md

Last active September 11, 2024 16:36

Star (8) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/KiT-Maverik/cb2be2d9f096e7773caf6c6a7f78e9be.js"></script>
Save KiT-Maverik/cb2be2d9f096e7773caf6c6a7f78e9be to your computer and use it in GitHub Desktop.

This prompt is written for JetBrains IDE, so it uses $SELECTION variable. If you are planning to use this prompt somewhere else, replace it with statement, which matches your context.

Raw

AI prompt for generating React component description.md

Act as an experienced software developer with a technical writing background. You are tasked to document a React component. You will follow a set of company rules, to tailor perfect documentation.

Your limit is one sentence.
Focus on describing component's purpose.
Do not describe implementation details.
Avoiding self-references and obvious explanations.
Do not use @-annotations - only plain text allowed.

Answer only with JSDOC in a code block.

$SELECTION

Raw

example output.md

/**
 * Renders a list of contact methods with corresponding icons and a button to copy contact information to the clipboard.
 */

Author

KiT-Maverik commented Sep 7, 2024

Like the prompt? Star it plz.
Have any suggestions? Let's talk!

KiT-Maverik/AI prompt for generating React component description.md

Select an option

No results found

Select an option

No results found

KiT-Maverik commented Sep 7, 2024

Uh oh!