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 →“主要部分”→“子部分”，此組織將在匯出華夏公益教科書時自動重新建立。由於華夏公益教科書是我們內容的中央儲存庫，請維護此組織。重新組織華夏公益教科書需要將頁面複製到新位置，然後刪除原始頁面。