global-java-code-style

What problem does it solve?

This Skill provides a unified Java coding standard covering naming conventions, formatting, project structure, documentation, exception handling, testing, dependency management, security robustness, and AI code generation guidance to improve code quality and maintainability.

Core Features & Use Cases

• Naming conventions: classes and interfaces use UpperCamelCase; methods and variables use lowerCamelCase; constants use UPPER_SNAKE_CASE.
• Code formatting & structure: 4-space indentation, consistent brace style, and clean layout; recommended package naming and modular organization.
• Documentation & quality: Javadoc rules for public APIs, clear inline comments, and standardized sectioning to support maintainability.
• Use Case: During a project kickoff, teams adopt these guidelines to align all Java modules, enabling easier reviews and consistent code generation.

Quick Start

Audit a sample module to identify deviations from the guidelines, update class names to UpperCamelCase, enforce 4-space indentation, and add Javadoc for public APIs. Then apply an automated formatter and a lightweight check to ensure ongoing conformance. Finally, reference the provided examples in references/examples.md to guide migration and enforcement.