From 271e7f7847ca066ab8d8b5c9aafe45b573931111 Mon Sep 17 00:00:00 2001 From: CaiHQ Date: Tue, 18 Oct 2022 10:01:45 +0800 Subject: [PATCH] update annotation docs --- README.md | 10 +++++----- markdown/markdown/YJSAPI.md | 16 ++++++++++++++-- markdown/markdown_BDWare/conf.py | 22 +++++++++++----------- todo.md | 2 +- 4 files changed, 31 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index ebdb7d2..4768ed6 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ ## 环境依赖安装 ```bash #视情况使用pip/pip3 -pip install sphinx -pip install recommonmark -pip install sphinx_rtd_theme -pip install sphinx_markdown_tables -pip install sphinx-multiversion +pip3 install sphinx +pip3 install recommonmark +pip3 install sphinx_rtd_theme +pip3 install sphinx_markdown_tables +pip3 install sphinx-multiversion ``` # 更新版本 diff --git a/markdown/markdown/YJSAPI.md b/markdown/markdown/YJSAPI.md index add6503..428722a 100644 --- a/markdown/markdown/YJSAPI.md +++ b/markdown/markdown/YJSAPI.md @@ -361,10 +361,22 @@ export function count(args){ ``` @Cost({"countGas":true}) export function .... - - ``` +### @ArgSchema +该注解可以检查输入参数格式,仅支持JSON格式。 +``` +@ArgSchema({ +"!field1":"string", +"field2":"number", +"array":[{"abc":"number"}] +}) +``` + +### @Mask +该注解可对结果进行一定转换,支持差分隐私、MD5等转换函数。 + + ## IO工具类 ### 概览 diff --git a/markdown/markdown_BDWare/conf.py b/markdown/markdown_BDWare/conf.py index a4d7a61..aea1059 100644 --- a/markdown/markdown_BDWare/conf.py +++ b/markdown/markdown_BDWare/conf.py @@ -94,15 +94,15 @@ html_static_path = ['_static'] master_doc = 'index' -##latex_elements = { -## 'papersize': 'a4paper', +latex_elements = { + 'papersize': 'a4paper', # Additional stuff for the LaTeX preamble. -## 'preamble': ''' -##\usepackage{xeCJK} -##\usepackage{indentfirst} -##\setlength{\parindent}{2em} -##\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} -##\setCJKsansfont[BoldFont=STHeiti]{STXihei} -##\setCJKmonofont{STFangsong} -##''', -##} \ No newline at end of file + 'preamble': ''' +\usepackage{xeCJK} +\usepackage{indentfirst} +\setlength{\parindent}{2em} +\setCJKmainfont[BoldFont=STFangsong, ItalicFont=STKaiti]{STSong} +\setCJKsansfont[BoldFont=STHeiti]{STXihei} +\setCJKmonofont{STFangsong} +''', +} \ No newline at end of file diff --git a/todo.md b/todo.md index ae517b9..759324c 100644 --- a/todo.md +++ b/todo.md @@ -4,4 +4,4 @@ 等注解。 onRecover说明 -manifest里配置memeory参数。 \ No newline at end of file +manifest里配置memory参数。 \ No newline at end of file