摘錄自 O’REILLY 的 C++ 風格與藝術
程式寫越多註解的編排就越感重要
尤其是程式的註解有比較大的有比較小的
C++ 風格與藝術 這本書提供了一些不錯的編排方式
為了以後方便起見 就先打在上面以後複製比較方便XD
有侵權請告知 QQ
版權都是 O’REILLY© 的 = =+
直接複製就好 ( 雖然不知道為甚麼網頁對不齊 不過貼上去文字編輯器卻 ok = =?! )
技巧一
/
********** 警告 : 這是警告訊息的例子
藉以引起程式設計師的注意
/
技巧二
//--------------------------> 另一種比較不重要的警告 <---------------------------
技巧三
//>>>>>>>>>>>>>>>>>>> 主要部分開頭 <<<<<<<<<<<<<<<<<<<<<
技巧四
/
* 本書使用加框的註解來表示一段或整個程式的開始 *
********/
技巧五
/-----------------------------------------------------------------<br /> 另一種裝飾框的方法
*-----------------------------------------------------------------/
技巧六
/
* 這是一個部分的開始
* ^^^^^^^^^^^^^^^^^^^^^
在下面的段落中，我們解釋
該部分的任務及他是如何進行的。
/
技巧七
/
中等的註解，解釋接下來十幾行程式碼的作用。
* 雖然沒有粗體字可用，但照樣可以 ** 強調 ** 文字
*/
技巧八
// 最簡單的註解，解釋下一行