Agent skill
swift-docc-comments
Use when writing or enhancing Swift documentation comments for DocC generation, adding inline doc comments to Swift source files, or when user asks for API documentation
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/swift-docc-comments
SKILL.md
Swift DocC Inline Comments
Overview
Swift DocC inline comments follow a specific structure. Section headers like ## Overview and ## Topics belong in .docc catalog files, NOT in inline source comments.
Structure
/// Summary (first paragraph - one sentence)
///
/// Discussion paragraphs (no header needed)
///
/// ```swift
/// // Code example
/// ```
///
/// - Parameter name: Description
/// - Returns: Description
/// - Throws: Description
/// - Note: Additional info
Quick Reference
| Element | Format | Location |
|---|---|---|
| Summary | First paragraph | Inline |
| Discussion | Subsequent paragraphs | Inline |
| Code examples | Triple backticks | Inline, before parameters |
## Overview |
Section header | .docc catalog ONLY |
## Topics |
Section header | .docc catalog ONLY |
| Symbol links | ``SymbolName`` |
Both |
Correct Format
/// Brief summary in one sentence.
///
/// Extended discussion explaining behavior, use cases,
/// or important details. No header needed.
///
/// ```swift
/// let example = MyType()
/// example.doSomething()
/// ```
///
/// - Parameter value: What this parameter does.
/// - Returns: What gets returned.
/// - Note: Default value is `.default`.
func method(value: Int) -> String
Common Mistakes
| Wrong | Correct |
|---|---|
/// ## Overview |
Just write paragraphs |
/// ## Topics |
Use .docc catalog file |
/// ## Example |
Just use code block |
| Parameters before code | Code block, then parameters |
Red Flags
These indicate wrong format:
## Overviewin///comments## Topicsin///comments## Examplebefore code blocks- Parameter:appearing before code examples
Generate Documentation
swift package generate-documentation
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?