MNN深度学习框架代码规范与最佳实践指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00663/article/details/148394150

MNN深度学习框架代码规范与最佳实践指南

MNN MNN is a blazing fast, lightweight deep learning framework, battle-tested by business-critical use cases in Alibaba 项目地址: https://gitcode.com/gh_mirrors/mn/MNN

前言

MNN作为一款高性能的深度学习推理引擎，其代码质量直接影响框架的性能和稳定性。本文将详细介绍MNN项目的代码规范、命名约定和最佳实践，帮助开发者理解如何编写符合MNN标准的代码。

代码格式化工具

格式化工具配置

MNN采用clang-format作为代码格式化工具，项目根目录下的.clang-format文件定义了统一的代码风格规范。开发者应当使用以下工具保持代码风格一致：

新增文件格式化：

clang-format -i /path/to/new_file

修改文件格式化：

cd /path/to/MNN
git-clang-format

代码风格调整

MNN基于Google代码风格进行了以下主要调整：

| 配置项 | 说明 | 调整值 | |--------|------|--------| | AccessModifierOffset | 访问权限修饰符偏移 | -4 | | AlignConsecutiveAssignments | 连续赋值对齐 | true | | ColumnLimit | 最大行宽 | 120 | | IndentWidth | 缩进宽度 | 4 | | ObjCBlockIndentWidth | Objective-C块缩进 | 4 | | ObjCSpaceAfterProperty | Objective-C属性后空格 | true | | SpacesBeforeTrailingComments | 行尾注释前空格 | 1 |

这些调整使得代码更易读且符合项目需求。

命名规范

基本规则

驼峰命名法：C、C++和Objective-C代码统一使用驼峰命名法
- 类名：CityCat（大驼峰）
- 变量名：bigDoghouse（小驼峰）
前缀规则：
- 私有/保护成员变量：m前缀（如mCat）
- 全局变量/类静态变量：g前缀（如gWorld）
- 非static C函数/汇编函数：MNN前缀
可见性标记：所有对外暴露的函数和类必须使用MNN_PUBLIC宏标记

编码最佳实践

内存管理

临近释放原则：为避免内存泄漏，申请和释放内存应在相邻代码块中完成。推荐使用：

智能指针（如std::unique_ptr）
MNN提供的AutoStorage类

防御式编程

外部入参检查：

MNN_PUBLIC struct MNNNet* MNNCreateNet(const char* path) {
    if (NULL == path) {
        MNN_PRINT("input path is NULL, failed to create net!\n");
        return NULL;
    }
    // ...
}

内部参数断言：

void copyFloats(const float* input, float* output, int size) {
    MNN_ASSERT(NULL != input);
    MNN_ASSERT(NULL != output);
    for (int i = 0; i < size; ++i) {
        output[i] = input[i];
    }
}

禁止无理由忽略错误：

// 错误示例：无注释说明为何忽略NULL检查
void setUnitDimensions(const int* dims, int size) {
    if (NULL == dims) return;
    // ...
}

注释规范

所有非Op头文件必须包含以下注释：

类注释：说明类的用途
公共方法注释：非override的public方法需说明方法功能、参数和返回值
公共成员变量注释：说明变量用途

示例：

/**
 * @brief 计算两个向量的点积
 * @param vec1 第一个向量指针
 * @param vec2 第二个向量指针
 * @param size 向量长度
 * @return 点积计算结果
 */
float dotProduct(const float* vec1, const float* vec2, int size);