{"id":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","shortId":"qUgJfA","kind":"skill","title":"java-docs","tagline":"Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.","description":"# 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 <T>` for type parameters in generic types or methods.\n- Use `{@code}` for inline code snippets.\n- Use `<pre>{@code ... }</pre>` 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.","tags":["java","docs","awesome","copilot","github","agent-skills","agents","custom-agents","github-copilot","hacktoberfest","prompt-engineering"],"capabilities":["skill","source-github","skill-java-docs","topic-agent-skills","topic-agents","topic-awesome","topic-custom-agents","topic-github-copilot","topic-hacktoberfest","topic-prompt-engineering"],"categories":["awesome-copilot"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/github/awesome-copilot/java-docs","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"cli":"npx skills add github/awesome-copilot","source_repo":"https://github.com/github/awesome-copilot","install_from":"skills.sh"}},"qualityScore":"0.700","qualityRationale":"deterministic score 0.70 from registry signals: · indexed on github topic:agent-skills · 33270 github stars · SKILL.md body (1,293 chars)","verified":false,"liveness":"unknown","lastLivenessCheck":null,"agentReviews":{"count":0,"score_avg":null,"cost_usd_avg":null,"success_rate":null,"latency_p50_ms":null,"narrative_summary":null,"summary_updated_at":null},"enrichmentModel":"deterministic:skill-github:v1","enrichmentVersion":1,"enrichedAt":"2026-05-18T18:52:15.020Z","embedding":null,"createdAt":"2026-04-18T20:25:30.563Z","updatedAt":"2026-05-18T18:52:15.020Z","lastSeenAt":"2026-05-18T18:52:15.020Z","tsv":"'altern':214 'author':195,199 'base':134 'behavior':142 'best':15,22 'block':172 'case':146 'chang':143 'class':135 'code':163,166,169,171,202 'comment':12,33,63 'complex':51 'concis':72 'deprec':204,210 'descript':67,90 'differ':151 'doc':3 'document':9,18,20,30,38,114,132,149 'e.g':182 'encourag':36 'end':80,99 'ensur':4 'especi':47 'except':112,115 'explanatori':56 'featur':179 'first':58 'follow':14 'generic':158 'indic':176 'inherit':131 'inheritdoc':129 'inlin':165 'interfac':137 'introduc':181 'java':2,6,19 'java-doc':1 'javadoc':11,21,32,62 'letter':95 'lowercas':94 'major':141 'mark':206 'member':27,44,127,193,208 'method':77,87,106,118,161 'number':184 'overview':73 'packag':40 'package-priv':39 'param':85,153 'paramet':88,156 'period':83,102 'practic':16,23 'privat':41,43 'protect':26 'provid':212 'public':24 'refer':122 'return':104,107 'see':120 'self':55 'self-explanatori':54 'sentenc':59 'sinc':174 'skill' 'skill-java-docs' 'snippet':167 'source-github' 'specifi':188,197 'start':91 'summari':66 'throw':110 'thrown':116 'topic-agent-skills' 'topic-agents' 'topic-awesome' 'topic-custom-agents' 'topic-github-copilot' 'topic-hacktoberfest' 'topic-prompt-engineering' 'type':7,125,155,159 'unless':138 'use':84,103,109,119,128,152,162,168,173,185,194,203 'valu':108 'version':183,186,190 'well':46","prices":[{"id":"b0ed8446-65b1-40b1-b057-9b9a75687509","listingId":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","amountUsd":"0","unit":"free","nativeCurrency":null,"nativeAmount":null,"chain":null,"payTo":null,"paymentMethod":"skill-free","isPrimary":true,"details":{"org":"github","category":"awesome-copilot","install_from":"skills.sh"},"createdAt":"2026-04-18T20:25:30.563Z"}],"sources":[{"listingId":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","source":"github","sourceId":"github/awesome-copilot/java-docs","sourceUrl":"https://github.com/github/awesome-copilot/tree/main/skills/java-docs","isPrimary":false,"firstSeenAt":"2026-04-18T21:49:55.054Z","lastSeenAt":"2026-05-18T18:52:15.020Z"},{"listingId":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","source":"skills_sh","sourceId":"github/awesome-copilot/java-docs","sourceUrl":"https://skills.sh/github/awesome-copilot/java-docs","isPrimary":true,"firstSeenAt":"2026-04-18T20:25:30.563Z","lastSeenAt":"2026-05-07T22:40:17.331Z"}],"details":{"listingId":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","quickStartSnippet":null,"exampleRequest":null,"exampleResponse":null,"schema":null,"openapiUrl":null,"agentsTxtUrl":null,"citations":[],"useCases":[],"bestFor":[],"notFor":[],"kindDetails":{"org":"github","slug":"java-docs","github":{"repo":"github/awesome-copilot","stars":33270,"topics":["agent-skills","agents","ai","awesome","custom-agents","github-copilot","hacktoberfest","prompt-engineering"],"license":"mit","html_url":"https://github.com/github/awesome-copilot","pushed_at":"2026-05-18T01:26:59Z","description":"Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot.","skill_md_sha":"72ceae42766f50afdf41c11c374a91d13d627200","skill_md_path":"skills/java-docs/SKILL.md","default_branch":"main","skill_tree_url":"https://github.com/github/awesome-copilot/tree/main/skills/java-docs"},"layout":"multi","source":"github","category":"awesome-copilot","frontmatter":{"name":"java-docs","description":"Ensure that Java types are documented with Javadoc comments and follow best practices for documentation."},"skills_sh_url":"https://skills.sh/github/awesome-copilot/java-docs"},"updatedAt":"2026-05-18T18:52:15.020Z"}}