{"kind":"Skill","metadata":{"namespace":"community","name":"java-docs","version":"0.1.0"},"spec":{"description":"Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.","files":{"SKILL.md":"---\nname: java-docs\ndescription: 'Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.'\n---\n\n# Java Documentation (Javadoc) Best Practices\n\n- Public and protected members should be documented with Javadoc comments.\n- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.\n- 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.\n- Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period.\n- Use `@return` for method return values.\n- Use `@throws` or `@exception` to document exceptions thrown by methods.\n- Use `@see` for references to other types or members.\n- Use `{@inheritDoc}` to inherit documentation from base classes or interfaces.\n  - Unless there is major behavior change, in which case you should document the differences.\n- Use `@param \u003cT\u003e` for type parameters in generic types or methods.\n- Use `{@code}` for inline code snippets.\n- Use `\u003cpre\u003e{@code ... }\u003c/pre\u003e` for code blocks.\n- Use `@since` to indicate when the feature was introduced (e.g., version number).\n- Use `@version` to specify the version of the member.\n- Use `@author` to specify the author of the code.\n- Use `@deprecated` to mark a member as deprecated and provide an alternative.\n"},"import":{"commit_sha":"541b7819d8c3545c6df122491af4fa1eae415779","imported_at":"2026-05-18T20:05:35Z","license_text":"MIT License\n\nCopyright GitHub, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.","owner":"github","repo":"github/awesome-copilot","source_url":"https://github.com/github/awesome-copilot/tree/541b7819d8c3545c6df122491af4fa1eae415779/plugins/java-development/skills/java-docs"}},"content_hash":[56,147,68,185,8,98,202,221,63,181,53,209,142,150,244,41,124,107,8,87,241,66,0,180,219,93,139,116,167,169,223,52],"trust_level":"unsigned","yanked":false}