java-docs

Name: java-docs
Author: github

10kinstalls4.6kforks

How to install java-docs?

github/awesome-copilot/java-docs

$npx -y skills add github/awesome-copilot --skill java-docs

Installs into the current project.

Summary

Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.

Files · 1

View on GitHub

SKILL.md

1	# Java Documentation (Javadoc) Best Practices
2
3	- Public and protected members should be documented with Javadoc comments.
4	- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
5	- 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.
6	- Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period.
7	- Use `@return` for method return values.
8	- Use `@throws` or `@exception` to document exceptions thrown by methods.
9	- Use `@see` for references to other types or members.
10	- Use `{@inheritDoc}` to inherit documentation from base classes or interfaces.
11	- Unless there is major behavior change, in which case you should document the differences.
12	- Use `@param <T>` for type parameters in generic types or methods.
13	- Use `{@code}` for inline code snippets.
14	- Use `<pre>{@code ... }</pre>` for code blocks.
15	- Use `@since` to indicate when the feature was introduced (e.g., version number).
16	- Use `@version` to specify the version of the member.
17	- Use `@author` to specify the author of the code.
18	- Use `@deprecated` to mark a member as deprecated and provide an alternative.

People who liked this also viewed

6 picks

Type

grill-with-docsA relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.SkillsJul 2026537k182k
lark-minutes飞书妙记：搜索妙记、查看妙记基础信息、下载/上传音视频、读取或编辑妙记的产物内容、改标题、替换说话人/关键词、申请妙记查看/编辑权限。当给出minute_token、本地音视频文件，要查/改/转妙记产物，或用户明确要主动申请妙记权限时使用；本地音视频转纪要/逐字稿优先走本 skill，不要用 ffmpeg/whisper 本地转写。不负责：获取会议关联妙记，或仅按自然语言标题定位纪要SkillsJul 2026379k16k
lark-markdown飞书 Markdown：查看、创建、上传、编辑和比较 Markdown 文件。当用户需要创建或编辑 Markdown 文件、读取、修改、局部 patch 或比较差异时使用。不负责将 Markdown 导入为飞书在线文档，也不负责文件搜索、权限、评论、移动、删除等云空间管理操作。SkillsJul 2026295k16k
docxUse this skill whenever the user wants to create, read, edit, or manipulate Word documents (.docx files) or Word templates (.dotx files). Triggers include: any mention of 'Word doc', 'word document', SkillsJul 2026157k163k
edit-articleSkills for Real Engineers. Straight from my .agents directory.SkillsJul 2026154k181k
lark-note飞书会议纪要（Note）直查：已知 note_id 时查询纪要详情、展示类型、关联文档 token，并读取 unified 原始逐字记录。当用户已持有 note_id，或从文档显式 vc-node-id 获得 note_id 时使用。不负责会议/日程/妙记定位、文档标题搜索或 Docx 正文读取。SkillsJul 2026154k16k

java-docs

10kinstalls4.6kforks

View on GitHub

How to install java-docs?

github/awesome-copilot/java-docs

$npx -y skills add github/awesome-copilot --skill java-docs

Installs into the current project.

Summary

Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.

Files · 1

View on GitHub

SKILL.md

1	# Java Documentation (Javadoc) Best Practices
2
3	- Public and protected members should be documented with Javadoc comments.
4	- It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.
5	- 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.
6	- Use `@param` for method parameters. The description starts with a lowercase letter and does not end with a period.
7	- Use `@return` for method return values.
8	- Use `@throws` or `@exception` to document exceptions thrown by methods.
9	- Use `@see` for references to other types or members.
10	- Use `{@inheritDoc}` to inherit documentation from base classes or interfaces.
11	- Unless there is major behavior change, in which case you should document the differences.
12	- Use `@param <T>` for type parameters in generic types or methods.
13	- Use `{@code}` for inline code snippets.
14	- Use `<pre>{@code ... }</pre>` for code blocks.
15	- Use `@since` to indicate when the feature was introduced (e.g., version number).
16	- Use `@version` to specify the version of the member.
17	- Use `@author` to specify the author of the code.
18	- Use `@deprecated` to mark a member as deprecated and provide an alternative.

People who liked this also viewed

6 picks

Type