# Java Docs > Ensure that Java types are documented with Javadoc comments and follow best practices for documentation. Use when this capability is needed. - Skill: `tomevault-io/java-docs` (Agent Skill, multi-file: 2 files) - Install (CLI): `npx skillmds@latest add tomevault-io/java-docs` - Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/java-docs/raw - Safety review: pending (external: skill-scanner PASS, skillspector PASS) - Works with: Claude Code, Claude.ai, OpenAI Codex - Category: Docs & Writing - Author: tomevault-io (https://skillmd.com/u/tomevault-io) - Updated: 2026-09-17 - Page: https://skillmd.com/skills/tomevault-io/java-docs --- # Java Documentation (Javadoc) Best Practices - Public and protected members should be documented with Javadoc comments. - It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory. - The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period. - Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period. - Use `@return` for method return values. - Use `@throws` or `@exception` to document exceptions thrown by methods. - Use `@see` for references to other types or members. - Use `{@inheritDoc}` to inherit documentation from base classes or interfaces. - Unless there is major behavior change, in which case you should document the differences. - Use `@param ` for type parameters in generic types or methods. - Use `{@code}` for inline code snippets. - Use `
{@code ... }
` for code blocks. - Use `@since` to indicate when the feature was introduced (e.g., version number). - Use `@version` to specify the version of the member. - Use `@author` to specify the author of the code. - Use `@deprecated` to mark a member as deprecated and provide an alternative. --- > Source: [mivek/MetarParser](https://github.com/mivek/MetarParser) — distributed by [TomeVault](https://tomevault.io).