Astroneer Wiki
Advertisement
Template-info.png 文档

使用时请创建模板的 /doc 子页面并添加描述文档,在文档的开头处用{{doc/start}}标记,结尾处用{{doc/end}}标记。再返回到主模板页,将 <noinclude>{{doc}}</noinclude> 添加在模板内容之后新的一行上。

/doc 子页面会自动归类到Category:文档模板

可选参数

clear

可以使用此参数解决主模板的浮动内容遮挡住文档内容的问题。此时请用{{doc/start|clear}}替换文档页开头的{{doc/start}}

该参数还可以用于没有使用 <includeonly> 的模板,因其能在模板和文档框之间添加一些空间。

nodoc=1

如果模板缺少描述文档,同时您又不了解其使用方法,请用{{doc/start|nodoc=1}}(或者同时需要 clear 时,{{doc/start|clear|nodoc=1}})替换文档页上的{{doc/start}}

此时文档背景会变红而更醒目,页面也会归类至Category:无文档模板

baddoc=1

类似于 nodoc,此参数用于标记文档质量欠佳的模板,比如文档缺少示例,未正确说明全部功能,或没有解释重点。

此时文档背景会变黄而更醒目,页面也会归类至Category:不合格文档模板

同时声明 nodoc 和 baddoc 时,baddoc 会被忽略。


Advertisement