원클릭으로
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
// 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
Use when releasing a new plugin version, bumping versions, creating git tags, or publishing GitHub releases for this marketplace
Use when encountering Swift 6 concurrency errors, Sendable conformance warnings, actor isolation issues, "global variable is not concurrency-safe" errors, or migrating codebases to Swift 6 language mode
Use when setting up DocC documentation for a Swift package, deploying to GitHub Pages, or encountering "no such module 'UIKit'" during doc generation
Use when creating demo GIFs for Swift package READMEs, recording iOS simulator videos, or setting up demo apps for SwiftUI libraries
| name | swift-docc-comments |
| description | 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 |
| allowed-tools | Read, Grep, Glob |
Swift DocC inline comments follow a specific structure. Section headers like ## Overview and ## Topics belong in .docc catalog files, NOT in inline source comments.
/// Summary (first paragraph - one sentence)
///
/// Discussion paragraphs (no header needed)
///
/// ```swift
/// // Code example
/// ```
///
/// - Parameter name: Description
/// - Returns: Description
/// - Throws: Description
/// - Note: Additional info
| 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 |
/// 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
| Wrong | Correct |
|---|---|
/// ## Overview | Just write paragraphs |
/// ## Topics | Use .docc catalog file |
/// ## Example | Just use code block |
| Parameters before code | Code block, then parameters |
These indicate wrong format:
## Overview in /// comments## Topics in /// comments## Example before code blocks- Parameter: appearing before code examplesswift package generate-documentation