在本節中,我們將介紹關於所有類型的評論中使用c++。評論往往是鑒於編碼但至少重要性讀更多的時間比實際的代碼行。它們主要用來解釋c++代碼,增加可讀性,減少其認知複雜性。除了提供基本的信息文件,日誌等功能,作者,年,改變他們經常建議選擇當前實現的原因。它也可以用來防止測試替代代碼時執行。
證據確鑿的程序通常是一個預期的交付的程序員。評論使一個程序可讀性更強,更容易發現錯誤。程序員通常包括標簽來創建低水平文檔的代碼。評論也在代碼檢查服務器的一個重要目的。如一個評論的功能使其空間和時間複雜度將幫助評論家欣賞功能的效率,看看它如何影響整個模塊。
在幾乎所有的編程語言,注釋是一個程序員能讀懂的解釋或注釋來解釋下麵的代碼。注釋語句被編譯器忽略(他們不執行)。在c++中,評論都是singled-lined和多行。
單行注釋從2開始正斜杠(/ /)。文本夾在/ /和結束線是由編譯器忽略(不執行)。
/ /輸出Hello World !控製台cout < <“Hello World !”;這個例子使用一行代碼之前一個單行的評論。反斜杠是連續字符並將繼續評論如下:
/ /這句話也會評論以下行\ std:: cout < <“這條線不會打印”< < std:: endl;c++多行注釋他們開始用/ *和* /結束。/ *和* /之間的任何文本將被編譯器忽略。
/ * *下麵的代碼將打印Hello World !*在屏幕上* / cout < <“Hello World !”;作為一般規則,每個對象在一個c++程序中應該有一個注釋塊,文件,函數,常量,宏,預處理程序、類等。任何您的程序的語句不明顯或複雜的應該說。同樣,任何使用外部庫函數調用應該注釋。以下是文件頭的例子通常出現在源或頭文件
/ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *項目:Hello World * *文件:你好。cpp * * Function: Main Entry point of the program * * Description: Prints the words "Hello world" to the * screen * * Author: Nikhil Jain [nj] (nikhil.XXX@gmail.com) * * Year: 2020-2021 * * Environment: g++ (Ubuntu 7.5.0-3ubuntu1~18.04) 7.5.0. * * Notes: This is an introductory, sample program. * * Revisions: 1.00 10/1/2020 (nj) First release * *******************************************************/評論有時也用來封閉實驗或試驗代碼,我們暫時希望編譯器忽略。這可能是有用的在發現程序中的錯誤。如果一個程序不提供所需的結果,它可能跟蹤特定語句包含錯誤的注釋代碼。下麵的注釋塊上麵放置一個函數定義
以下是一個類的注釋塊
/ * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - <版權聲明>確定輸入類型是相同類型b .示例:模板< typename T, typename U >空白do_something (const T, const U, bool標誌);模板< typename T, typename U >空白do_something (const T T, const U U) {do_something (T, U, is_same < T U >::值);}- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - * /下麵是好方法注釋一個函數可以創建這樣的低水平的文檔,供進一步參考。
/ / / <總結>排序的列表來給定列< /總結> / / / < param name = " sel_criteria " >列進行排序(index-1-based)和排序方向(pos =升序)。< / param > / / / <返回>文檔返回類型的< / >返回void CDBTaglist:: SetSorting (int sel_criteria) {…}