Coverage of Documentation Comments Style Guide

# Context
This issue tracks the work for the **GSoC** project [Coverage of Documentation Comments Style Guide](https://github.com/checkstyle/checkstyle/wiki/Checkstyle-GSoC-2026-Project-Ideas#project-name-coverage-of-documentation-comments-style-guide)

The initial infrastructure for the new Documentation Comments Style Guide coverage has been created in PR https://github.com/checkstyle/checkstyle/pull/19801 and updated in PRs https://github.com/checkstyle/checkstyle/pull/19828 and https://github.com/checkstyle/checkstyle/pull/19942.

That work introduces: `doc_comments_style.xml`, `doc_comments_checks.xml`.
The configuration currently contains only one check: `AtclauseOrder`.

The remaining work is to expand `doc_comments_checks.xml` to cover the applicable rules from the style guide and to complete all `???` entries in `doc_comments_style.xml`.

In the [coverage page](https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/485efb5_20260516225447/doc_comments_style.html), `???` means that the report is still incomplete for that chapter or rule.

# Tracking
## Issue Status Legend

| Status | Meaning |
|---|---|
| 🔵 **Awaiting Initial Review** | The issue proposal has been submitted and is waiting for its first review. |
| 🟡 **Under Review** | The issue proposal is currently being evaluated. Feedback, discussion, or additional validation may still be in progress. |
| 🟢 **Approved** | The issue proposal has been reviewed and accepted. The work can proceed. |
| ✅ **Completed** | The issue has been fully resolved and no further action is required. |

## Introduction
### Principles
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Writing API Specifications | https://github.com/checkstyle/checkstyle/issues/19823 | 🟢 | / |
| Writing Programming Guide Documentation | https://github.com/checkstyle/checkstyle/issues/19834 | 🟢 | / |

## Writing Doc Comments
### Format of a Doc Comment
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Format of a Doc Comment | https://github.com/checkstyle/checkstyle/issues/19821 | 🟢 | Existing checks |
| Notes | https://github.com/checkstyle/checkstyle/issues/19808 | 🟡 |  |
### Descriptions
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| First Sentence | https://github.com/checkstyle/checkstyle/issues/19835 | 🟢 | Existing check |
| Implementation-Independence, Automatic re-use of method comments - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19881#issuecomment-4500669045) | https://github.com/checkstyle/checkstyle/issues/19881 | ✅ | / |
### A Style Guide
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| &lt;code&gt; style for keywords and names | https://github.com/checkstyle/checkstyle/issues/19882 | 🟢 | / |
| In-line links | https://github.com/checkstyle/checkstyle/issues/19883 | 🟢 | New checks |
| Method and constructor parentheses, Phrases instead of sentences, Third-person descriptions - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19907#issuecomment-4510971419) | https://github.com/checkstyle/checkstyle/issues/19907 | 🔵 |  |
| Method descriptions, Class, interface, and field descriptions - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19910#issuecomment-4511092106) | https://github.com/checkstyle/checkstyle/issues/19910 | 🔵 |  |
| Use of “this”, Description beyond API name, Use of “field” - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19911#issuecomment-4510974149) | https://github.com/checkstyle/checkstyle/issues/19911 | 🔵 |  |
| Latin terms | https://github.com/checkstyle/checkstyle/issues/19913 | 🟡 |  |
### Tag Conventions
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Order of Tags | https://github.com/checkstyle/checkstyle/pull/19801 | ✅ | Existing check |
| Ordering Multiple Tags | https://github.com/checkstyle/checkstyle/issues/19914 | 🟡 |  |
| Required Tags | https://github.com/checkstyle/checkstyle/issues/19915 | 🟢 | Existing check |
| `@author` | https://github.com/checkstyle/checkstyle/issues/19916 | ✅ | / |
| `@version` | https://github.com/checkstyle/checkstyle/issues/19918 | 🔵 |  |
| `@param` | https://github.com/checkstyle/checkstyle/issues/19919 | 🟡 |  |
| `@return` | https://github.com/checkstyle/checkstyle/issues/19920 | 🟢 | Existing check |
| `@deprecated` | https://github.com/checkstyle/checkstyle/issues/19921 | 🟡 |  |
| `@since` | https://github.com/checkstyle/checkstyle/issues/19922 | 🟢 | Existing check (needs update) |
| `@throws` | https://github.com/checkstyle/checkstyle/issues/19923 | 🟢 | Existing check |
| `@see`, `@serial`, `@serialField`, `@serialData`, `{@link}` - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19924#issuecomment-4517269727) | https://github.com/checkstyle/checkstyle/issues/19924 | 🔵 |  |
| Custom Tags and Annotations | https://github.com/checkstyle/checkstyle/issues/19925 | 🔵 |  |
### Documenting Default Constructors
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Documenting Default Constructors | https://github.com/checkstyle/checkstyle/issues/19926 | 🟢 | Existing check |
### Documenting Exceptions with `@throws` Tag
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Guidelines - Which Exceptions to Document | https://github.com/checkstyle/checkstyle/issues/19927 | 🟢 | Existing check |
| Documenting Unchecked Exceptions | https://github.com/checkstyle/checkstyle/issues/19928 | 🔵 |  |
| Background on the Throws Clause | https://github.com/checkstyle/checkstyle/issues/19929 | 🟡 |  |
### Package-Level Comments
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Template for package.html source file | https://github.com/checkstyle/checkstyle/issues/19930 | 🟢 | Existing check |
| Contents of package.html source file | https://github.com/checkstyle/checkstyle/issues/19931 | 🟡 |  |
### Including Images
| Subsection | Child Issue | Status | Checks Coverage |
|------------|-------------|--------|-------------|
| Naming of doc images in source tree | https://github.com/checkstyle/checkstyle/issues/19934 | 🟡 |  |
| Location of doc images in source tree | https://github.com/checkstyle/checkstyle/issues/19935 | 🟢 | / |
| Naming of doc images in HTML destination, Location of doc images in HTML destination - [Why multiple chapters](https://github.com/checkstyle/checkstyle/issues/19936#issuecomment-4519160385) | https://github.com/checkstyle/checkstyle/issues/19936 | ✅ | / |

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Coverage of Documentation Comments Style Guide #19807

Context

Tracking

Issue Status Legend

Introduction

Principles

Writing Doc Comments

Format of a Doc Comment

Descriptions

A Style Guide

Tag Conventions

Documenting Default Constructors

Documenting Exceptions with `@throws` Tag

Package-Level Comments

Including Images

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Status	Meaning
🔵 Awaiting Initial Review	The issue proposal has been submitted and is waiting for its first review.
🟡 Under Review	The issue proposal is currently being evaluated. Feedback, discussion, or additional validation may still be in progress.
🟢 Approved	The issue proposal has been reviewed and accepted. The work can proceed.
✅ Completed	The issue has been fully resolved and no further action is required.

Subsection	Child Issue	Status	Checks Coverage
Writing API Specifications	#19823	🟢	/
Writing Programming Guide Documentation	#19834	🟢	/

Subsection	Child Issue	Status	Checks Coverage
Format of a Doc Comment	#19821	🟢	Existing checks
Notes	#19808	🟡

Subsection	Child Issue	Status	Checks Coverage
First Sentence	#19835	🟢	Existing check
Implementation-Independence, Automatic re-use of method comments - Why multiple chapters	#19881	✅	/

Subsection	Child Issue	Status	Checks Coverage
<code> style for keywords and names	#19882	🟢	/
In-line links	#19883	🟢	New checks
Method and constructor parentheses, Phrases instead of sentences, Third-person descriptions - Why multiple chapters	#19907	🔵
Method descriptions, Class, interface, and field descriptions - Why multiple chapters	#19910	🔵
Use of “this”, Description beyond API name, Use of “field” - Why multiple chapters	#19911	🔵
Latin terms	#19913	🟡

Subsection	Child Issue	Status	Checks Coverage
Order of Tags	#19801	✅	Existing check
Ordering Multiple Tags	#19914	🟡
Required Tags	#19915	🟢	Existing check
`@author`	#19916	✅	/
`@version`	#19918	🔵
`@param`	#19919	🟡
`@return`	#19920	🟢	Existing check
`@deprecated`	#19921	🟡
`@since`	#19922	🟢	Existing check (needs update)
`@throws`	#19923	🟢	Existing check
`@see`, `@serial`, `@serialField`, `@serialData`, `{@link}` - Why multiple chapters	#19924	🔵
Custom Tags and Annotations	#19925	🔵

Subsection	Child Issue	Status	Checks Coverage
Guidelines - Which Exceptions to Document	#19927	🟢	Existing check
Documenting Unchecked Exceptions	#19928	🔵
Background on the Throws Clause	#19929	🟡

Subsection	Child Issue	Status	Checks Coverage
Template for package.html source file	#19930	🟢	Existing check
Contents of package.html source file	#19931	🟡

Subsection	Child Issue	Status	Checks Coverage
Naming of doc images in source tree	#19934	🟡
Location of doc images in source tree	#19935	🟢	/
Naming of doc images in HTML destination, Location of doc images in HTML destination - Why multiple chapters	#19936	✅	/

Uh oh!

Coverage of Documentation Comments Style Guide #19807

Description

Context

Tracking

Issue Status Legend

Introduction

Principles

Writing Doc Comments

Format of a Doc Comment

Descriptions

A Style Guide

Tag Conventions

Documenting Default Constructors

Documenting Exceptions with @throws Tag

Package-Level Comments

Including Images

Metadata

Metadata

Assignees

Labels

Type

Fields

Projects

Milestone

Relationships

Development

Issue actions

Documenting Exceptions with `@throws` Tag