Add language
Add language
# User Prompt
Code Commenting Guidelines:

Focus on "Why", not "What": Avoid commenting on obvious code. Instead, explain the rationale behind complex logic or non-obvious business rules.

Docstrings: Provide concise docstrings for all public functions, classes, and modules, describing their purpose, parameters, and return values.

Complex Algorithms: Break down intricate logic with step-by-step inline comments to improve maintainability.

Technical Debt & Hacks: Clearly mark any "workarounds" or "hacks" with TODO: or FIXME: explaining why the shortcut was taken.
Code Commenting Guidelines
1
0
1

Provides guidelines for writing effective code comments, emphasizing explaining the 'why' behind logic, using docstrings, breaking down complex algorithms, and marking technical debt.

Language
English
Created2 months ago
Last updated12 days ago
Creator

Services with a clipboard icon will copy the prompt to your clipboard first.

Version History
Prompt documentation
Comments (0)
Please log in to leave a comment.

Be the first to comment

to start the conversation.

Related Prompts
English

Analyzes a provided code snippet and suggests specific refactoring strategies to enhance readability and maintainability.

1
3
0

English中文

Transforms workflow to use Manus-style persistent markdown files for planning, progress tracking, and knowledge storage. Use when starting complex tasks, multi-step projects, research tasks, or when the user mentions planning, organizing work, tracking progress, or wants structured output.

1
3
0

English

A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.

0
3
0

English中文PortuguêsFrançais

Using AI for Code Reviews and Improvements, AI is great for catching issues you might miss and suggesting improvements.

6
10
4

EnglishDeutschEspañolFrançais日本語한국어Português中文

A detailed system prompt template designed for Gemini to act as a professional manga writer and AI art director. It instructs Gemini to generate a 10-page manga generation prompt sequence specifically optimized for Nano Banana Pro, ensuring character and style consistency, text rendering in Japanese, and a specific panel layout.

6
5
2

English中文

Cursor Rules - used for Cursor IDE

6
11
0