軟體工程師手冊/語言詞典/示例模板
外觀
<描述語言,如果可能,包括簡要歷史。>
<描述這是否是一種指令碼語言、小型語言、完整語言:過程式或函式式。>
<描述程式如何/在哪裡啟動,例如 C++ 的 main()>
<嘗試對典型程式碼行的內容進行高階描述。賦值示例可能適用,例如
a = b;
>
<描述並展示註釋的語法,例如
// this is an inline comment. Everything after the // is a comment.
塊註釋由起始 /* 和結束 */ 指定,它們可以跨越多行。
/* * this is a block comment */
>
<描述是否需要變數宣告,並給出不同型別變數的示例,例如
將 i 宣告為整數
int i;
兩種方法將 i 宣告為整數並賦予其初始值為 0
int i = 0; int i(0);
>
<描述方法/函式/過程是如何宣告和實現的。>
<描述作用域是如何定義的。>
<用文字描述條件語句,並給出
code examples.
(在行首新增一個空格以格式化為程式碼)>
<用英文描述迴圈語句並給出程式碼示例。>
<描述如何輸出“Hello world!”,包括換行符,使用或不使用回車符。>
<描述錯誤處理和恢復。根據需要給出示例。>
<列出此語言原生提供的容器或容器列表的參考。列出如果容器不是語言原生提供的,那麼如何整合容器。>
<列出此語言原生提供的演算法或演算法列表的參考。列出如果演算法不是語言原生提供的,那麼如何整合演算法。或者,如果不可用,則描述。>
<描述垃圾收集是自動的還是手動的。>
<描述檔案、庫和部分通常是如何劃分和排列的。>
<請包含便於從另一種語言切換到這種語言的提示。>
<列出網路上的其他參考資料。請包括參考資料適合什麼級別的讀者。(初學者/中級/高階)>
<列出可能有所幫助的其他書籍和文章。請包括參考資料適用於什麼級別的讀者。(初級/中級/高階)>