# @protobufjs/codegen 中文文档

规范地址：https://npmcn.com/package/%40protobufjs/codegen/

版本：2\.0\.5
npm 元数据更新时间：2026-04-27T20:30:11.919Z
中文译文更新时间：2026-11-05T15:44:32.410Z
软件包许可：BSD-3-Clause

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40protobufjs/codegen
原文对照：https://npmcn.com/package/%40protobufjs/codegen/?lang=original
项目主页：https://github.com/dcodeIO/protobuf.js#readme
源码仓库：https://github.com/dcodeIO/protobuf.js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9.7 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2016-12-11T00:10:02.575Z
- 最新版本发布：2026-04-27T20:30:11.789Z
- 近 30 天下载量：300955076（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 1 个）

## 中文简介

最小化代码生成工具 .

## 安装

```sh
npm install @protobufjs/codegen
```

也可以使用：`pnpm add @protobufjs/codegen`、`yarn add @protobufjs/codegen`、`bun add @protobufjs/codegen`

## README

# @ protobufjs/ 编码源

[![npm](https://img.shields.io/npm/v/@protobufjs/codegen.svg)](https://www.npmjs.com/package/@protobufjs/codegen)

最小化代码生成工具 .

## API 密码

-   **代码( \[函数\] 参数 : `string[]`\[功能名称:字符串\]: `Codegen`**  
    开始生成函数 .
    
-   **代码源.动词= `false`**  
    当设定为真时, 代码源会日志生成的代码到控制台 。 用于调试 .
    

引用 **代码** 返回将代码附加到函数正文并返回自身的附件函数:

-   **代码( 格式串: `string`,\[.格式Params: `any`\[ \]: 代码**  
    附加函数正文的代码. 格式字符串可以包含指定所插入格式参数类型的占位符 :
    
    -   `%d`: 数字(整数或浮动点值)
    -   `%f`: 浮点值
    -   `%i`: 整数
    -   `%j`: JSON. 刻出"定值"
    -   `%s`: 字符串值
    -   `%%`: 百分比符号  
        
-   **代码( \[范围 : `Object.<string,*>`\[ \]: `Function`**  
    完成函数并返回.
    
-   **Codegen.to String( \[函数\] 名称 : `string`\[ \]: `string`**  
    返回函数为字符串.
    

## 示例

```js
var codegen = require("@protobufjs/codegen");

var add = codegen(["a", "b"], "add") // A function with parameters "a" and "b" named "add"
  ("// awesome comment")             // adds the line to the function's body
  ("return a + b - c + %d", 1)       // replaces %d with 1 and adds the line to the body
  ({ c: 1 });                        // adds "c" with a value of 1 to the function's scope

console.log(add.toString()); // function add(a, b) { return a + b - c + 1 }
console.log(add(1, 2));      // calculates 1 + 2 - 1 + 1 = 3
```

**许可证 :** [BSD 3- 标签许可证](https://opensource.org/licenses/BSD-3-Clause)

## 常见问题

### @protobufjs/codegen 是什么？

最小化代码生成工具 \.

### 如何安装 @protobufjs/codegen？

在项目目录运行 npm install @protobufjs/codegen，或使用 pnpm add / yarn add / bun add。

### @protobufjs/codegen 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @protobufjs/codegen 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @protobufjs/codegen 可以商用吗？

@protobufjs/codegen 使用 BSD-3-Clause 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。另外不得用原作者名义为衍生产品背书。以上为概括，不构成法律意见，请以许可原文为准。

### @protobufjs/codegen 的下载量有多少？

根据 npm 官方下载统计，@protobufjs/codegen 在 2026/10/06 – 2026/11/04 这 30 天内被下载 300,955,076 次，日均约 10,031,836 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @protobufjs/codegen 还在维护吗？

最新版本 2\.0\.5 发布于 2026/04/28（6 个月前）；至今共发布 15 个版本，其中过去 12 个月发布了 1 个；首次发布于 2016/12/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。