样式指南
向此文档贡献的指南
这个文档需要是说明性的。贡献者需要解释如何做一件事,并且分成合理的逻辑块来讨论。
我们也有一个wiki页,你可以在那找到更全面的代码示例。
我们的读者是任何想要理解如何使用Forge来制作一个mod的人。
请不要将这个文档变成一个Java开发教程——该文档的目标读者是那些理解Java类(Class)是怎么工作的,并且知道Java的一些其他基础结构的人。
格式
重要
请使用两个空格来缩进,而不是Tab。 (Please use TWO SPACES to indent, not tabs.)
标题应该根据标准标题大写格式进行大写。比如,
- Guide For Contributing to This Documentation
- Building and Testing Your Mod
换句话说,大写除了不重要单词以外的所有的单词
请使用等号(=)和横线(-)下划线来显示标题,而不是 #
和 ##
。对于h3和更低等级的标题,使用 ###
等是可以的。这个文件的源码包含了等号和横线标题的用法示例。等号创建h1文字,横线创建h2文字。