Sample Prompt for Creating Source Code Documentation

In software development, source code documentation is just as important as the code itself. A well-built system lacking clear documentation will hinder maintenance, expansion, and collaboration among team members. However, documentation is often overlooked due to its time-consuming nature and potential for inconsistency.

The emergence of artificial intelligence has opened up a more efficient approach: using prompts to automate and standardize the code documentation process. Through well-designed prompt templates, programmers can quickly create detailed descriptions of functionality, system structure, processing flow, and API usage while ensuring clarity and consistency.

The source code documentation prompt template focuses on building and implementing high-quality prompts to support the documentation process effectively. This is not only a time-saving solution but also contributes to improving the quality of software products, helping development teams work more efficiently and sustainably.

Sample Prompt for Creating Source Code Documentation

English example text

Best suited for: Claude 4 Sonnet, GPT-5

Instructions for Using the Sample Prompt

1. Replace [PASTE CODE OR FUNCTION] with the code you want to use to create a reference.
2. Select the format as XML Annotations.

The Example Prompt Is a Sample Execution Using Gpt-5

 Order: """English example text""" order = Order.objects.create(user=user, status="PENDING") total_price = 0 for item in items: product = Product.objects.get(id=item["product_id"]) if product.stock < item["quantity"]: raise ValueError("Not enough stock") product.stock -= item["quantity"] product.save() OrderItem.objects.create( order=order, product=product, quantity=item["quantity"], price=product.price ) total_price += product.price * item["quantity"] order.total_price = total_price order.save() return order Bao gom: - Mo ta ham/lop - Tai lieu tham so - Tai lieu gia tri tra ve - Vi du su dung - Cac truong hop ngoai le va xu ly loi - o phuc tap ve thoi gian/khong gian inh dang: Chu thich XML

Below is the detailed XML document for the OrderService as requested:

English example text O(1) (khong tinh bo nho database). Bo nho su dung khong tang ang ke theo input. Co the xay ra race condition khi nhieu request cung cap nhat stock. Nen su dung select_for_update() hoac locking. Nen toi uu bang cach preload products e tranh N+1 query problem. Nen validate input truoc khi xu ly (quantity > 0).