Coding Guidelines Java

What it does

This skill provides Java coding guidelines to ensure code quality and consistency. It helps generate code that adheres to established best practices, including formatting, naming conventions, and common design patterns. The goal is to improve readability, maintainability, and reduce potential errors in Java projects.

When to use it

• Generating new Java classes or methods where adherence to coding standards is crucial.
• Reviewing existing Java code for compliance with established guidelines.
• Creating documentation that explains specific coding conventions within a project.
• Refactoring legacy Java code to improve its structure and readability.

Key capabilities

• Provides formatting rules for Java code.
• Enforces naming conventions for variables, methods, and classes.
• Suggests common design patterns based on the context of the code.

Example prompts

• "Generate a Java class for a 'User' with appropriate fields and getter/setter methods following standard conventions."
• "Review this Java method and suggest improvements to adhere to coding guidelines: [paste code here]"
• "What is the recommended naming convention for a private variable representing a user’s email address in Java?"

Tips & gotchas

The skill's effectiveness depends on providing clear context about the desired coding style. While it can provide suggestions, it may not be aware of project-specific or company-internal guidelines that are more restrictive.