编码规范

风格来源

基本规则

格式化命令

./scripts/core/lint format # 全量格式化
./scripts/core/lint check # 只检查(不修改)

命名约定

命名例外

代码组织

目录结构

include/fqtools/ # 公共 API 头文件
src/ # 内部实现代码
src/cli/ # 命令行入口
src/cli/commands/ # 子命令实现
src/processing/ # 处理逻辑(Mutators, Predicates)
src/statistics/ # 统计分析逻辑
src/io/ # 输入输出处理

头文件包含顺序

接口设计

现代 C++ 实践

资源管理

// 优先使用智能指针
std::unique_ptr<Processor> processor = create_processor();
std::shared_ptr<Config> config = std::make_shared<Config>();
// 禁止裸露的 new/delete

函数声明

// 统一使用尾随返回类型
auto processBatch(const Batch& batch) -> Result;

错误处理

// 优先使用异常
if (!is_valid(input)) {
 throw InvalidInputError("Invalid input file");
}

字符串处理

// 优先使用 string_view 作为只读参数
auto process_sequence(std::string_view sequence) -> bool;

C++23 特性

CLI 规范

命令命名

选项格式

全局选项

工具脚本规范

#!/bin/bash
set -euo pipefail # 严格模式
# 函数命名: snake_case
print_info() {
 echo "INFO: $*"
}
# 变量引用: 双引号
run_build "$compiler" "$build_type"

文档规范

API 文档

/**
 * @brief 处理 FASTQ 批次数据
 * @param batch 要处理的批次数据
 * @return 处理结果
 * @throws ProcessingError 处理失败时抛出
 */
auto processBatch(const Batch& batch) -> Result;

代码注释

相关页面