ivan-magda/claude-superpowers/swift-docc-comments

Name: swift-docc-comments
Author: ivan-magda

Claude Code and agent skill by ivan-magda/claude-superpowers

Trust tier 3

community

By ivan-magda
Coding
ivan-magda/claude-superpowers
Plugin swift
plugins/swift/skills/swift-docc-comments/SKILL.md
Updated 6 Oct 2026
Version 1.0.01 version recorded

Source check pending

Checking that the SKILL.md file is still in the repository.

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

npx vskill@latest install ivan-magda/claude-superpowers/swift-docc-comments

SKILL.md

The same SKILL.md was published earlier as majiayu000/claude-skill-registry/swift-docc-comments.

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

`swift

/// 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:

## Overview in /// comments
## Topics in /// comments
## Example before code blocks
- Parameter: appearing before code examples

Generate Documentation

bash

swift package generate-documentation

Security

Security scanPassed, 95 of 100Pattern checks on the skill's files.
Model reviewPassed

See the full security report

Quality evaluation

Task evaluationNot runNo evaluation yet. Run one in Skill Studio.

See evaluation results

Source

SKILL.md in the repositoryCheckingplugins/swift/skills/swift-docc-comments/SKILL.md

Popularity

7-day trend score: 5

Not refreshed yet.

Works with

Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.

Claude Code
Cursor
GitHub Copilot
Windsurf
Codex
Gemini CLI
Cline
Amp
Roo Code
Goose
Continue
Kilo Code
Junie
Trae
OpenHands
Qwen Code
AI Agent
Tabnine Chat
Sourcegraph Cody
Amazon Q
Firebase Genkit
Sweep
Devin
Phind
Mentat
Claude Desktop
Aider
GPT Pilot
Plandex
bolt.new
v0
Replit Agent
Anse
TypingMind
BetterChatGPT
LibreChat
Warp AI
Pieces
Fig AI

Embed badge

[![vskill VERIFIED](https://verified-skill.com/api/v1/skills/ivan-magda/claude-superpowers/swift-docc-comments/badge)](https://verified-skill.com/skills/ivan-magda/claude-superpowers/swift-docc-comments)

Something wrong with this skill or its page? Tell us.