Futurebasic/appendix/styleguide

FutureBASIC 文档样式指南

在贡献时，尽可能遵循“FB 语言简介”一章中规定的惯例。这些惯例包括以下内容

• 在斜体中的项目代表占位符，应根据描述进行替换；
• 在粗体文本中的项目代表文字，应按显示的格式输入；
• 在普通非斜体文本中的项目代表文字，通常应按显示的格式输入。

代码示例

请遵守以下代码规范

1. FB 关键字：小写（print，而不是 PRINT）或“骆驼式命名法”（HandleEvents，而不是 HANDLEEVENTS）。
   1. 混合大小写格式是首选。
   2. 请不要对维基教科书文本进行颜色编码。
   3. 当我们导出到 HTML 或 HTML 帮助时，将添加 CSS “类”（<code class="keyword">）来控制关键字的外观。
      需要注意的是，维基教科书不支持 CSS。
2. 工具箱调用：苹果的命名约定
3. 用户函数：首字母大写（fn MyFunction()）
4. 变量：以小写字母开头（x、myVariable）
5. 全局变量：以小写字母 g 开头（gSomeGlobal）

文本中的代码

维基教科书支持<code>标签。此标签以等宽字体（通常为 Courier 或 Courier New）呈现封闭的文本。不幸的是，文本并不总是易于阅读，因此请避免使用斜体或其他效果，除非绝对必要。

代码块

对于大型代码块，请使用<pre>（预格式化）标签

// This is sample code

<PRE>标签将示例代码放置在一个框中。它还通过以等宽字体呈现代码来保留格式。

文档组织

当文档可以组织在文件夹（目录）中时，使用以下标准

1. 语言：按功能组织的语法概述
2. Intro：FutureBASIC 编程入门（注意：请为真正的初级程序员撰写内容）
3. Programming：中级到高级编程主题
4. FBtoC：FBtoC 的解释
5. Tutorials：编程示例及更多
6. Appendix：其他信息

文件夹名称在维基教科书链接中显示为小写。这些文件夹进一步细分为特定主题。在创建此文本的子文件夹（子部分）之前，请务必查看目录。维基教科书条目链接来自 FutureBASIC →“主要部分”→“子部分”，此组织将在导出维基教科书时自动重新创建。由于维基教科书是我们内容的中央存储库，请维护此组织。重新组织维基教科书需要将页面复制到新位置，然后删除原始页面。