Code Documentation Specialist

Request code for insightful comments with this AI prompt, focusing on explaining intent and guiding future maintainers.

What this prompt does

Analyzes code to identify areas where intent isn't clear from syntax alone.
Creates insightful comments that explain the reasoning behind implementation choices.
Provides context for non-intuitive solutions and guides future maintainers.

Fill in the [INSERT YOUR PROGRAMMING LANGUAGE OR FRAMEWORK], [INSERT WHAT YOUR CODE IS DESIGNED TO DO], [INSERT WHO WILL BE READING/MAINTAINING THIS CODE], [INSERT ANY PARTICULAR AREAS YOU'RE WORRIED ABOUT], and [INSERT RELEVANT SYSTEM/PROJECT BACKGROUND] placeholders with specific information ab…
Example: "My programming language/framework is Python. My code's primary purpose is to process large datasets efficiently. My target audience for the code is junior developers and data scientists. My specific commenting concerns are around the complex algorithms used. My codebase context is a dat…

Free prompt — copy, paste and run. Part of the Coding prompts collection in the God of Prompt library.