Skip to content

Documentation Comments Style Guide - Use <code> style for keywords and names #19882

@gianmarcoschifone

Description

@gianmarcoschifone

Parent issue: #19807

Coverage table

Use <code> style for keywords and names

Chapter link

Content

Image

Image

Text

Use <code> style for keywords and names

Keywords and names are offset by <code>...</code> when mentioned in a description. This includes:

Java keywords
package names
class names
method names
interface names
field names
argument names
code examples

Guidelines

This chapter doesn't appear to contain any implementable rule. Proposal:

Documentation Comments Rule Checkstyle Checks Used Sample files
Use <code> style for keywords and names --
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions