类 VipCopyright

软著源代码生成器

支持Java、JavaScript、TypeScript、Python、C、C++、Go、Swift、PHP、Rust、Shell、SQL、YAML、XML、HTML、Text等语言
支持生成源代码文档
支持生成源代码文档的前30页、后30页、前后30页

索引

构造函数

方法

generateDocx saveCodeToDocx scanSourceCode quickGenerateDocx

构造函数

constructor

new VipCopyright(
    copyrightTitle: string,
    copyrightVersion: string,
    options?: CopyrightOptions,
): VipCopyright
参数
- copyrightTitle: string
- copyrightVersion: string
- 可选options: CopyrightOptions
返回 VipCopyright
- 定义于 copyright.ts:56

方法

generateDocx

generateDocx(sourceCodeDir: string, fileType: CopyrightFileType): Promise<void>
生成源代码文档
参数
- sourceCodeDir: string
- fileType: CopyrightFileType
返回 Promise<void>
- 定义于 copyright.ts:94

saveCodeToDocx

saveCodeToDocx(
    fileName: string,
    sourceLines: string[],
    pageCount: number,
): Promise<void>
存储代码到文档中
参数
- fileName: string
- sourceLines: string[]
- pageCount: number
返回 Promise<void>
- 定义于 copyright.ts:130

scanSourceCode

scanSourceCode(
    sourceCodeDir: string,
    fileType: CopyrightFileType,
): {
    allSourceCode: string[];
    beginSourceCode: string[];
    endSourceCode: string[];
}
根据文件路径，扫描源码
参数
- sourceCodeDir: string
- fileType: CopyrightFileType
返回 { allSourceCode: string[]; beginSourceCode: string[]; endSourceCode: string[] }
- 定义于 copyright.ts:157

`静态`quickGenerateDocx

quickGenerateDocx(
    options: {
        copyrightTitle: string;
        copyrightVersion: string;
        fileType: CopyrightFileType;
        sourceCodeDir: string;
    },
): Promise<void>
快速生成文档
参数
- options: {
      copyrightTitle: string;
      copyrightVersion: string;
      fileType: CopyrightFileType;
      sourceCodeDir: string;
  }
返回 Promise<void>
- 定义于 copyright.ts:81