Template:Doc

模板文档

[刷新缓存]

“文档(/doc)”是模板的一个子页面。它应当以{{doc/start}}开头，并以{{doc/end}}结尾。

接下来回到模板，在最后新起一行加上<noinclude>{{doc}}</noinclude>，/doc页面的内容便会自动加入到Category:Template documentation.

可选参数

clear

If your main template page has floating content and you would like to stop it going over the documentation, put {{doc/start|clear}} instead of {{doc/start}} on your documentation page.
This is also useful for templates not using <includeonly>, as it will put some space between the template and the documentation box.

nodoc=1

If a template has no documentation and you don't know how to use it, put {{doc/start|nodoc=1}} (or if the template needs clear as well, {{doc/start|clear|nodoc=1}}) instead of {{doc/start}} on your documentation page.
The documentation's background will become red to make it more noticeable, and the page will be added to Category:Templates with no documentation.

baddoc=1

Similar to nodoc, this is used to mark templates that do have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template properly.
The documentation's background will become yellow to make it more noticeable, and the page will be added to Category:Templates with bad documentation.

同时使用nodoc和baddoc时，后者不会生效。