Help:Best Practice/zh

From Kiwiphp

Contents 1 文档命名 2 统一格式 3 增强源码可读性，尽量wiki语法代替HTML标签 4 增强页面可读性 5 其他格式 6 表格格式

文档命名

• 文档名称使用英文，尽量简短，便于收藏
• 引入命名空间，例如：[[Help:Best Practice]]
• 文档的层级使用子页面表示，例如：[[Roadmap:Feature Requirement/Unfiled]]

统一格式

• 术语名词使用粗体，例如：'''MVC'''
• 标识符使用等宽字体，例如：<tt>kiwi_runtime_path</tt>
• 单行代码(如命令、URL)使用等宽字体：<code>header("Location: http://openid.yahoo.com");</code>
• 多行代码使用SyntaxHighlight_GeSHi加亮源代码
• 非标识符的专有名词使用斜体，例如：''Hello World''项目

增强源码可读性，尽量wiki语法代替HTML标签

• 用空行代替<br />
• 用[[Image:Geographylogo.png|center]] 代替 <center>[[Image:Geographylogo.png]]</center>
• 内部链接不要用外部链接的形式，如[[Special:Userlogin]]不要写成[http://wiki.kiwiphp.com/Special:Userlogin]

增强页面可读性

• 多使用空行，增加可读性。
• 句子超过20个字，中间要考虑加入标点进行断句，或者拆成两句话。

其他格式

• 目录：<div style="float:right; width:250px; margin-left:50px; margin-bottom:20px;">__TOC__</div>

表格格式

• 黄色：style="border-collapse: collapse; background-color: #ffffcc; border: 1px solid #ffcc66;
• 蓝色：style="border-collapse: collapse; background-color: #ecf5fa; border: 1px solid #8899dd;
• 绿色：style="border-collapse: collapse; background-color: #ddffbb; border: 1px solid #88dd00;

所有其他本文没有提及的技巧和规则，参考mediawiki官方网站，多使用Edit和View Source功能。