mirror of
https://gitee.com/BDWare/bdcontract-doc
synced 2025-01-10 09:54:17 +00:00
update annotation docs
This commit is contained in:
parent
213e351560
commit
271e7f7847
10
README.md
10
README.md
@ -2,11 +2,11 @@
|
|||||||
## 环境依赖安装
|
## 环境依赖安装
|
||||||
```bash
|
```bash
|
||||||
#视情况使用pip/pip3
|
#视情况使用pip/pip3
|
||||||
pip install sphinx
|
pip3 install sphinx
|
||||||
pip install recommonmark
|
pip3 install recommonmark
|
||||||
pip install sphinx_rtd_theme
|
pip3 install sphinx_rtd_theme
|
||||||
pip install sphinx_markdown_tables
|
pip3 install sphinx_markdown_tables
|
||||||
pip install sphinx-multiversion
|
pip3 install sphinx-multiversion
|
||||||
```
|
```
|
||||||
|
|
||||||
# 更新版本
|
# 更新版本
|
||||||
|
@ -361,10 +361,22 @@ export function count(args){
|
|||||||
```
|
```
|
||||||
@Cost({"countGas":true})
|
@Cost({"countGas":true})
|
||||||
export function ....
|
export function ....
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### @ArgSchema
|
||||||
|
该注解可以检查输入参数格式,仅支持JSON格式。
|
||||||
|
```
|
||||||
|
@ArgSchema({
|
||||||
|
"!field1":"string",
|
||||||
|
"field2":"number",
|
||||||
|
"array":[{"abc":"number"}]
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
### @Mask
|
||||||
|
该注解可对结果进行一定转换,支持差分隐私、MD5等转换函数。
|
||||||
|
|
||||||
|
|
||||||
## IO工具类
|
## IO工具类
|
||||||
|
|
||||||
### 概览
|
### 概览
|
||||||
|
@ -94,15 +94,15 @@ html_static_path = ['_static']
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
|
|
||||||
##latex_elements = {
|
latex_elements = {
|
||||||
## 'papersize': 'a4paper',
|
'papersize': 'a4paper',
|
||||||
# Additional stuff for the LaTeX preamble.
|
# Additional stuff for the LaTeX preamble.
|
||||||
## 'preamble': '''
|
'preamble': '''
|
||||||
##\usepackage{xeCJK}
|
\usepackage{xeCJK}
|
||||||
##\usepackage{indentfirst}
|
\usepackage{indentfirst}
|
||||||
##\setlength{\parindent}{2em}
|
\setlength{\parindent}{2em}
|
||||||
##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong}
|
\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong}
|
||||||
##\setCJKsansfont[BoldFont=STHeiti]{STXihei}
|
\setCJKsansfont[BoldFont=STHeiti]{STXihei}
|
||||||
##\setCJKmonofont{STFangsong}
|
\setCJKmonofont{STFangsong}
|
||||||
##''',
|
''',
|
||||||
##}
|
}
|
Loading…
Reference in New Issue
Block a user