File: Comment.md

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (19 lines) | stat: -rw-r--r-- 573 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# ``docc/Comment``

Captures a writer comment that's not visible in the rendered documentation.

@Metadata {
    @DocumentationExtension(mergeBehavior: override)
}

## Overview

Use a comment directive to include author notes, like reminders to add more content, in your reference documentation or tutorial. DocC ignores comments when your documentation builds, and they don't appear in the rendered content.

```markdown
@Comment {
    Add lots more photos of sloths here!
} 
````

<!-- Copyright (c) 2021 Apple Inc and the Swift Project authors. All Rights Reserved. -->