How to get better documentation from Cursor

1---
2description: Documentation standards
3globs: "src/**/*.ts"
4alwaysApply: true
5---
6
7## Documentation Rules
8- Every class must have a docstring with:
9  - One-line summary
10  - @description with purpose and architectural role
11  - @relationships listing dependent and dependency classes
12  - @example with basic usage
13- Every public method must have:
14  - @param for each parameter with type and purpose
15  - @returns with type and description
16  - @throws for each possible error
17- For complex classes, include a Mermaid classDiagram in the docstring
18- Use @see to reference related classes and modules

1// Cursor Chat prompt (Cmd+L):
2// @src/services/OrderService.ts @src/repositories/OrderRepository.ts
3// @.cursor/rules/documentation.mdc
4// Generate a PaymentService class that processes payments for orders.
5// Include full JSDoc with Mermaid class diagram showing relationships
6// to OrderService, PaymentGateway, and NotificationService.
7
8/**
9 * PaymentService — processes payments for customer orders.
10 *
11 * @description Handles payment processing, refunds, and payment
12 * status tracking. Coordinates between the order service and
13 * external payment gateway.
14 *
15 * @relationships
16 * - Depends on: OrderService (order lookup), PaymentGateway (processing)
17 * - Depended on by: OrderController, WebhookHandler
18 * - Notifies: NotificationService (payment events)
19 *
20 * ```mermaid
21 * classDiagram
22 *   OrderController --> PaymentService
23 *   PaymentService --> OrderService
24 *   PaymentService --> PaymentGateway
25 *   PaymentService --> NotificationService
26 *   class PaymentService {
27 *     +processPayment(orderId, amount)
28 *     +refundPayment(paymentId)
29 *     +getPaymentStatus(paymentId)
30 *   }
31 * ```
32 */

1// Select the class declaration, press Cmd+K:
2// @src/services/OrderService.ts @src/repositories/UserRepository.ts
3// Add comprehensive JSDoc documentation to this class.
4// Include: summary, description with architectural role,
5// relationships (depends on, depended on by), Mermaid class
6// diagram, and @example usage. Document all public methods
7// with @param, @returns, and @throws.

1// Cursor Chat prompt (Cmd+L):
2// @src/services/ Generate a module-level JSDoc comment for
3// src/services/index.ts that documents:
4// - All services in this directory and their purposes
5// - The dependency graph between services
6// - A Mermaid flowchart showing the service layer architecture
7// - Which services are entry points vs internal
8
9/**
10 * @module services
11 *
12 * Service layer handling business logic.
13 *
14 * ```mermaid
15 * flowchart TD
16 *   OrderController --> OrderService
17 *   OrderService --> PaymentService
18 *   OrderService --> InventoryService
19 *   PaymentService --> NotificationService
20 *   InventoryService --> NotificationService
21 * ```
22 *
23 * Entry points: OrderService, UserService, AuthService
24 * Internal: NotificationService, InventoryService
25 */

1// After adding a new method to PaymentService, press Cmd+K:
2// "Update the JSDoc for this class to include the new
3// refundPartial() method. Update the Mermaid diagram
4// if any new relationships were added. Keep all existing
5// documentation intact."