{"id":"5e265d73-ecd5-47f2-b7d2-d0e3f67e51bd","shortId":"qUgJfA","kind":"skill","title":"Java Docs","tagline":"Awesome Copilot skill by Github","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"],"capabilities":["skill","source-github","category-awesome-copilot"],"categories":["awesome-copilot"],"synonyms":[],"warnings":[],"endpointUrl":"https://skills.sh/github/awesome-copilot/java-docs","protocol":"skill","transport":"skills-sh","auth":{"type":"none","details":{"install_from":"skills.sh"}},"qualityScore":"0.300","qualityRationale":"deterministic score 0.30 from registry signals: · indexed on skills.sh · published under github/awesome-copilot","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:v1","enrichmentVersion":1,"enrichedAt":"2026-04-22T17:40:17.516Z","embedding":null,"createdAt":"2026-04-18T20:25:30.563Z","updatedAt":"2026-04-22T17:40:17.516Z","lastSeenAt":"2026-04-22T17:40:17.516Z","tsv":"'altern':203 'author':184,188 'awesom':3 'base':123 'behavior':131 'best':11 'block':161 'case':135 'category-awesome-copilot' 'chang':132 'class':124 'code':152,155,158,160,191 'comment':22,52 'complex':40 'concis':61 'copilot':4 'deprec':193,199 'descript':56,79 'differ':140 'doc':2 'document':9,19,27,103,121,138 'e.g':171 'encourag':25 'end':69,88 'especi':36 'except':101,104 'explanatori':45 'featur':168 'first':47 'generic':147 'github':7 'indic':165 'inherit':120 'inheritdoc':118 'inlin':154 'interfac':126 'introduc':170 'java':1,8 'javadoc':10,21,51 'letter':84 'lowercas':83 'major':130 'mark':195 'member':16,33,116,182,197 'method':66,76,95,107,150 'number':173 'overview':62 'packag':29 'package-priv':28 'param':74,142 'paramet':77,145 'period':72,91 'practic':12 'privat':30,32 'protect':15 'provid':201 'public':13 'refer':111 'return':93,96 'see':109 'self':44 'self-explanatori':43 'sentenc':48 'sinc':163 'skill':5 'snippet':156 'source-github' 'specifi':177,186 'start':80 'summari':55 'throw':99 'thrown':105 'type':114,144,148 'unless':127 'use':73,92,98,108,117,141,151,157,162,174,183,192 'valu':97 'version':172,175,179 'well':35","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-04-22T12:52:15.543Z"},{"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-04-22T17:40:17.516Z"}],"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","source":"skills_sh","category":"awesome-copilot","skills_sh_url":"https://skills.sh/github/awesome-copilot/java-docs"},"updatedAt":"2026-04-22T17:40:17.516Z"}}