Loading...
Loading...
Found 7 Skills
Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.
Use when you need to generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements — through a modular, step-based interactive process that adapts to your specific documentation needs. Part of the skills-for-java project
Provides comprehensive guidance for adding Java code comments following industry standards and best practices. This skill helps add class-level comments, method-level comments, and field-level comments to Java code. Use when the user wants to add comments to Java code, needs to document Java classes/methods/fields, wants to improve code documentation, or needs to generate JavaDoc comments. This skill covers Controller, Service, ServiceImpl, Mapper, Model, Entity, BO (Business Object), DTO, VO, and other common Java component types. The skill follows a systematic workflow: scan codebase, identify components, create todo list, and add comments in order (class comments → method comments → field comments).
This skill provides comprehensive guidance for documenting SAP APIs following official SAP API Style Guide standards. It should be used when creating or reviewing API documentation for REST, OData, Java, JavaScript, .NET, or C/C++ APIs. The skill covers naming conventions, documentation comments, OpenAPI specifications, quality checklists, deprecation policies, and manual documentation templates. It ensures consistency with SAP API Business Hub standards and industry best practices. Keywords: SAP API, REST, OData, OpenAPI, Swagger, Javadoc, JSDoc, XML documentation, API Business Hub, API naming, API deprecation, x-sap-stateInfo, Entity Data Model, EDM, documentation tags, API quality, API templates
Critical Standard Bottom-Up Self-Check (check-standards, Convergence Gate) after Java backend code generation/modification. **This skill must be loaded after any Java code is written or modified—including scattered coding that does not follow the complete development process (e.g., "write an XX interface"/"write a Controller"/"help me write this code"): this skill must be loaded and verified before delivering code products to users**. It uses grep/ast-grep to actually scan and verify each standard—comments (class/field/method Javadoc/step comments, including private and extracted methods), logs (full class @Slf4j, each business method has logs, ERROR exceptions with stack traces), transaction rollbackFor, constructor injection, layered boundaries, SQL in XML, unified return body, pagination limit, password encryption, SQL comments/injection/WHERE, and all other verification items, with "File:Line Number" evidence attached to each item; **No level distinction—any item that is not implemented properly (regardless of importance) will be listed in the pending confirmation list to confirm with the user whether to complete it**. **Correct intermediate product naming and paths before verification** (Technical Solution 3.x.1 / Interface List 3.x.2 / Standard Verification Report 5.2.x / Acceptance Report 5.3.x, remove the task ID prefix T0xx from file names and move to the module version directory). Trigger scenarios: after writing code, after code generation, after modifying code, **before delivering code**, pre-submission check, code standard verification/review, comment and log verification, code review, standard self-check, bottom-up check, acceptance review, product file naming correction, file renaming and relocation, **perform standard scanning on specified directories/modules/packages (e.g., "run check-standards on xx directory"/"verify order module standards"/"only scan the code modified this time")**. It can be used with ai-dev-workflow 5.2 standard verification node / 5.3 acceptance, or triggered independently (output the report in the dialogue and prompt the user for confirmation when there are no docs/no process).
Provides comprehensive guidance for searching and retrieving Maven components from Maven Central Repository (https://repo1.maven.org/maven2/). This skill enables searching by groupId, artifactId, version, and other coordinates, retrieving component metadata (POM files, JARs, sources, Javadoc), querying version history, and analyzing dependencies. Use when the user needs to find, verify, or retrieve Maven dependencies, check component versions, analyze dependency trees, or work with Maven coordinates.
Write comprehensive code documentation including JSDoc, Python docstrings, inline comments, function documentation, and API comments. Use when documenting code, writing docstrings, or creating inline documentation.