| Type | Convention | Example |
|------|-----------|---------|
| Classes/Interfaces | PascalCase | `SuggestIndexer`, `ReadingConverter` |
| Methods | camelCase | `createIndexIfNothing()` |
| Constants | UPPER_SNAKE_CASE | `DEFAULT_MAX_READING_NUM` |
| Packages | lowercase | `org.codelibs.fess.suggest` |

### JavaDoc Requirements

All public classes and methods require JavaDoc with `@param`, `@return`, and `@throws` tags.

import org.mortbay.jetty.Server;
import org.mortbay.jetty.handler.AbstractHandler;
import org.mortbay.jetty.handler.DefaultHandler;
import org.mortbay.jetty.handler.HandlerList;

/**
 * @author shinsuke
 *
 */
public class ApiExtractorTest extends PlainTestCase {
    final int port = 9876;

    final String ATTR_NAME = "filedata";

    private TestApiExtractorServer server;

    private ApiExtractor extractor;

    @Override

 * - Lock-free operations for better concurrency
 * - Proper buffer validation and limits
 */
public class BufferCache {

    /**
     * Private constructor to prevent instantiation of this utility class.
     */
    private BufferCache() {
        // Utility class - not instantiable
    }

    private static final int MAX_BUFFERS = Config.getInt("jcifs.smb1.smb.maxBuffers", 16);

    private static final long serialVersionUID = 1L;
    protected static final Class<?> suppressUnusedImportLocalDateTime = LocalDateTime.class;

    // ===================================================================================
    //                                                                           Attribute

JSON Schema在最新的一个版本中定义了一个字段 <a href="https://json-schema.org/draft/2019-09/json-schema-validation.html#rfc.section.9.5" class="external-link" target="_blank">`examples`</a> ，但是 OpenAPI 基于之前的一个旧版JSON Schema，并没有 `examples`.

所以 OpenAPI为了相似的目的定义了自己的 <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#fixed-fields-20" class="external-link" target="_blank">`example`</a> (使用 `example`, 而不是 `examples`), 这也是文档 UI 所使用的 (使用 Swagger UI).

import java.util.LinkedHashSet;
import java.util.Set;
import java.util.function.Function;

import org.codelibs.fess.crawler.exception.CrawlerSystemException;

/**
 * This class represents the result data of a crawl.
 */
public class ResultData implements Serializable {
    private static final long serialVersionUID = 1L;

    /** The name of the transformer. */
    protected String transformerName;

import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import org.junit.jupiter.api.Test;

class DcerpcExceptionTest {

    /**
     * Test constructor DcerpcException(int error) with a known error code.
     */
    @Test
    void testConstructorWithError_knownCode() {

 * including processing delays, queue waiting times, and new URL discovery.
 */
public class FessIntervalController extends DefaultIntervalController {

    private static final Logger logger = LogManager.getLogger(FessIntervalController.class);

    /**
     * Default constructor.
     */
    public FessIntervalController() {
        super();
    }

    /**

/**
 * Console download progress meter.
 * <p>
 * This listener is not thread-safe and should be wrapped in the {@link SimplexTransferListener} in a multi-threaded scenario.
 */
@Deprecated
public class ConsoleMavenTransferListener extends AbstractMavenTransferListener {

    private final Map<TransferResourceIdentifier, TransferResourceAndSize> transfers =

For example, let's add <a href="https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md#x-logo" class="external-link" target="_blank">ReDoc's OpenAPI extension to include a custom logo</a>.

### Normal **FastAPI** { #normal-fastapi }

First, write all your **FastAPI** application as normally: