본문으로 건너뛰기
cccskills
무료GitHub에 공개

java-docs

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

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config
설치 방법 보기

포함된 파일(1)

  • SKILL.md1.4 KB

SKILL.md(원문)

설치하기 전에 에이전트에게 전달되는 지시 내용을 확인할 수 있습니다.

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 <T> for type parameters in generic types or methods.
  • Use {@code} for inline code snippets.
  • Use <pre>{@code ... }</pre> 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.

리뷰

아직 리뷰가 없습니다. 사용해 본 소감을 남겨 주세요.

댓글

로그인 없이 쓸 수 있습니다. 사용 후기, 질문, 작동하지 않은 환경 등을 편하게 남겨 주세요.

아직 댓글이 없습니다. 첫 댓글을 남겨 보세요.

보내면 바로 공개됩니다. 이메일 주소나 전화번호 같은 개인 정보는 쓰지 마세요. URL은 2개까지입니다.

0 / 1,000자

이 양식은 reCAPTCHA로 보호되며 Google 개인정보처리방침 및 서비스 약관이 적용됩니다.

같은 저장소의 스킬

accessibility

무료

Primary accessibility skill for VS Code. REQUIRED for new feature and contribution work, and also applies to updates of existing UI. Covers accessibility help dialogs, accessible views, verbosity settings, signals, ARIA announcements, keyboard navigation, and ARIA labels/roles.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

acquire-codebase-knowledge

무료

Use this skill when the user explicitly asks to map, document, or onboard into an existing codebase. Trigger for prompts like "map this codebase", "document this architecture", "onboard me to this repo", or "create codebase docs". Do not trigger for routine feature implementation, bug fixes, or narrow code edits unless the user asks for repository-level discovery.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

act-on-feedback

무료

Act on user feedback attached to the current session. Use when the user submits feedback on the session's changes via the Submit Feedback button.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

add-educational-comments

무료

Add educational comments to the file specified, or prompt asking for file to comment if one is not provided.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

add-policy

무료

Use when adding, modifying, or reviewing VS Code configuration policies. Covers the full policy lifecycle from registration to export to platform-specific artifacts. Run on ANY change that adds a `policy:` field to a configuration property.

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

agent-governance

무료

Patterns and techniques for adding governance, safety, and trust controls to AI agent systems. Use this skill when: - Building AI agents that call external tools (APIs, databases, file systems) - Implementing policy-based access controls for agent tool usage - Adding semantic intent classification to detect dangerous prompts - Creating trust scoring systems for multi-agent workflows - Building audit trails for agent actions and decisions - Enforcing rate limits, content filters, or tool restrictions on agents - Working with any agent framework (PydanticAI, CrewAI, OpenAI Agents, LangChain, AutoGen)

한국어 요약은 준비 중입니다. 원문 설명을 표시하고 있습니다.

jcasnellie69/homelab-config22026년 10월 16일 업데이트

jcasnellie69의 스킬 모두 보기

이 스킬의 문제 신고