Hardhat Docgen – 安全帽Docgen区块链毕设代写
区块链毕设代写本文提供国外最新区块链项目源码下载,包括solidity,eth,fabric等blockchain区块链,Hardhat Docgen – 安全帽Docgen区块链毕设代写 是一篇很好的国外资料
Hardhat Docgen
Generate NatSpec documentation automatically on compilation with Hardhat.
Installation
yarn add --dev hardhat-docgen
Usage
Load plugin in Hardhat config:
require('hardhat-docgen');
Add configuration under the docgen
key:
option | description | default |
---|---|---|
path |
path to HTML export directory (relative to Hardhat root) | './docgen' |
clear |
whether to delete old files in path on documentation generation |
false |
runOnCompile |
whether to automatically generate documentation during compilation | false |
docgen: { path: './docs', clear: true, runOnCompile: true, }
The path
directory will be created if it does not exist.
The clear
option is set to false
by default because it represents a destructive action, but should be set to true
in most cases.
The included Hardhat task may be run manually; however, it is imperative that the compile
task be run at least once after plugin installation to ensure that the correct compiler options are set:
yarn run hardhat docgen
Hardhat Docgen
使用Hardhat编译时自动生成NatSpec文档。
安装
yarn add --dev hardhat-docgen
用法
在Hardhat config中加载插件:
require('hardhat-docgen');
在docgen键下添加配置:
option | description | default |
---|---|---|
路径 | HTML导出目录的路径(相对于Hardhat根) | ‘./Docgen’ |
清除 | 是否在生成文档时删除路径中的旧文件 | false |
runOnCompile | 是否在编译期间自动生成文档 | false |
docgen: { path: './docs', clear: true, runOnCompile: true, }
如果路径目录不存在,将创建它。
清除选项默认设置为false,因为它表示破坏性操作,但在大多数情况下应设置为true。
包含的安全帽任务可以手动运行;但是,必须在插件安装后至少运行一次编译任务,以确保设置了正确的编译器选项:
yarn run hardhat docgen
部分转自网络,侵权联系删除区块链源码网
区块链知识分享网, 以太坊dapp资源网, 区块链教程, fabric教程下载, 区块链书籍下载, 区块链资料下载, 区块链视频教程下载, 区块链基础教程, 区块链入门教程, 区块链资源 » Hardhat Docgen – 安全帽Docgen区块链毕设代写