@142vip.copyright.Class.VipCopyright - 142vip/core-x GitHub Wiki

API 参考 / @142vip/copyright / VipCopyright

Class: VipCopyright

Defined in: copyright.ts:30

软著源代码生成器

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

Constructors

Constructor

new VipCopyright(copyrightTitle, copyrightVersion, options?): VipCopyright

Defined in: copyright.ts:56

Parameters

copyrightTitle

string

copyrightVersion

string

options?

CopyrightOptions

Returns

VipCopyright

Methods

generateDocx()

generateDocx(sourceCodeDir, fileType): Promise<void>

Defined in: copyright.ts:94

生成源代码文档

Parameters

sourceCodeDir

string

fileType

CopyrightFileType

Returns

Promise<void>


saveCodeToDocx()

saveCodeToDocx(fileName, sourceLines, pageCount): Promise<void>

Defined in: copyright.ts:130

存储代码到文档中

Parameters

fileName

string

sourceLines

string[]

pageCount

number

Returns

Promise<void>


scanSourceCode()

scanSourceCode(sourceCodeDir, fileType): object

Defined in: copyright.ts:157

根据文件路径,扫描源码

Parameters

sourceCodeDir

string

fileType

CopyrightFileType

Returns

object

allSourceCode

allSourceCode: string[]

beginSourceCode

beginSourceCode: string[]

endSourceCode

endSourceCode: string[]


quickGenerateDocx()

static quickGenerateDocx(options): Promise<void>

Defined in: copyright.ts:81

快速生成文档

Parameters

options
copyrightTitle

string

copyrightVersion

string

fileType

CopyrightFileType

sourceCodeDir

string

Returns

Promise<void>

⚠️ **GitHub.com Fallback** ⚠️