編程里注釋
A. 編程中的注釋分為三類 單行注釋,多行注釋,文檔注釋;
暈~~~ 自己還是找到了 ·· 留給後來人吧···
http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html
java文檔注釋(有示例)
Java代碼規范--注釋
@author LEI
@version 1.10 2005-09-01
1 注釋文檔的格式注釋文檔將用來生成HTML格式的代碼報告,所以注釋文檔必須書寫在類、域、構造函數、方法、定義之前。注釋文檔由兩部分組成——描述、塊標記。
例如:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method equals to get.
*
* @param request
* the request send by the client to the server
* @param response
* the response send by the server to the client
* @throws ServletException
* if an error occurred
* @throws IOException
* if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
前兩行為描述,描述完畢後,由@符號起頭為塊標記注視。
2 注釋的種類2.1 文件頭注釋
文件頭注釋以 /*開始,以*/結束,需要註明該文件創建時間,文件名,命名空間信息。
例如:
/*
* Created on 2005-7-2
* /
2.2 類、介面注釋
類、介面的注釋採用 /** … */,描述部分用來書寫該類的作用或者相關信息,塊標記部分必須註明作者和版本。
例如:
/**Title: XXXX DRIVER 3.0
*Description: XXXX DRIVER 3.0
*Copyright: Copyright (c) 2003
*Company:XXXX有限公司
*
* @author Java Development Group
* @version 3.0
*/
例如:
/**
* A class representing a window on the screen.
* For example:
*
* Window win = new Window(parent);
* win.show();
*
*
* @author Sami Shaio
* @version %I%, %G%
* @see java.awt.BaseWindow
* @see java.awt.Button
*/
class Window extends BaseWindow {
...
}
2.3 構造函數注釋
構造函數注釋採用 /** … */,描述部分註明構造函數的作用,不一定有塊標記部分。
例如:
/**
* 默認構造函數
*/
有例如:
/**
* 帶參數構造函數,初始化模式名,名稱和數據源類型
*
* @param schema
* Ref 模式名
* @param name
* Ref 名稱
* @param type
* byVal 數據源類型
*/
2.4 域注釋
域注釋可以出現在注釋文檔裡面,也可以不出現在注釋文檔裡面。用/** … */的域注釋將會被認為是注釋文檔熱出現在最終生成的HTML報告裡面,而使用/* … */的注釋會被忽略。
例如:
/* 由於triger和表用一個DMSource,所以要區分和表的遷移成功標記 */
boolean isTrigerSuccess = false;
又例如:
/** 由於triger和表用一個DMSource,所以要區分和表的遷移成功標記 */
boolean isTrigerSuccess = false;
再例如:
/**
* The X-coordinate of the component.
*
* @see #getLocation()
*/
int x = 1263732;
2.5 方法注釋
方法注釋採用 /** … */,描述部分註明方法的功能,塊標記部分註明方法的參數,返回值,異常等信息。例如:
/**
* 設置是否有外碼約束
*
* @param conn
* Connection 與資料庫的連接
*/
2.6 定義注釋
規則同域注釋。
3 注釋塊標記3.1 標記的順序
塊標記將採用如下順序:
…
*
* @param (classes, interfaces, methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
* …
一個塊標記可以根據需要重復出現多次,多次出現的標記按照如下順序:
@author 按照時間先後順序(chronological)
@param 按照參數定義順序(declaration)
@throws 按照異常名字的字母順序(alphabetically)
@see 按照如下順序:
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package
3.2 標記介紹
3.2.1 @param標記
@param後面空格後跟著參數的變數名字(不是類型),空格後跟著對該參數的描述。
在描述中第一個名字為該變數的數據類型,表示數據類型的名次前面可以有一個冠詞如:a,an,the。如果是int類型的參數則不需要註明數據類型。例如:
…
* @param ch the char 用用來……
* @param _image the image 用來……
* @param _num 一個數字……
…
對於參數的描述如果只是一短語,最好不要首字母大寫,結尾也不要句號。
對於參數的描述是一個句子,最好不要首字母大寫,如果出現了句號這說明你的描述不止一句話。如果非要首字母大寫的話,必須用句號來結束句子。(英文的句號)
公司內部添加ByRef和ByVal兩個標記,例如:
* @param _image the image ByRef 用來……
說明該參數是引用傳遞(指針),ByVal可以省略,表示是值傳遞。
3.2.2 @return標記
返回為空(void)的構造函數或者函數,@return可以省略。
如果返回值就是輸入參數,必須用與輸入參數的@param相同的描述信息。
必要的時候註明特殊條件寫的返回值。
3.2.3 @throws 標記
@throws以前使用的是@exception。
@throws的內容必須在函數的throws部分定義。
3.2.4 @author標記
類注釋標記。
函數注釋裡面可以不出現@author。
3.2.5 @version
類注釋標記。
文章出處:http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html
B. c語言注釋符號是什麼
單行注釋和成對注釋。單行注釋以雙斜線(//)開頭。同一行中斜線右側的所有內容都是注釋,會被編譯器略過。 另一個分隔符是注釋符號對(/* */),它繼承自C語言。
C語言是一門面向過程的、抽象化的通用程序設計語言,廣泛應用於底層開發。C語言能以簡易的方式編譯、處理低級存儲器。C語言是僅產生少量的機器語言以及不需要任何運行環境支持便能運行的高效率程序設計語言。
盡管C語言提供了許多低級處理的功能,但仍然保持著跨平台的特性,以一個標准規格寫出的C語言程序可在包括類似嵌入式處理器以及超級計算機等作業平台的許多計算機平台上進行編譯。
最新的C語言標準是C18。
C語言是一門面向過程的計算機編程語言,與C++、C#、Java等面向對象編程語言有所不同。C語言的設計目標是提供一種能以簡易的方式編譯、處理低級存儲器、僅產生少量的機器碼以及不需要任何運行環境支持便能運行的編程語言。
C語言描述問題比匯編語言迅速、工作量小、可讀性好、易於調試、修改和移植,而代碼質量與匯編語言相當。C語言一般只比匯編語言代碼生成的目標程序效率低10%-20%。因此,C語言可以編寫系統軟體。
當前階段,在編程領域中,C語言的運用非常之多,它兼顧了高級語言和匯編語言的優點,相較於其它編程語言具有較大優勢。計算機系統設計以及應用程序編寫是C語言應用的兩大領域。同時,C語言的普適較強,在許多計算機操作系統中都能夠得到適用,且效率顯著。
C語言擁有經過了漫長發展歷史的完整的理論體系,在編程語言中具有舉足輕重的地位。
C. 編程中的注釋其實也是語言表示數字和數據而已嗎
光看代碼可以懂得,但是對於相對復雜的代碼來說,邏輯原理和變數參數的變化是非常復雜的,需要藉助東西來記憶,注釋則消除了這些復雜性,比如一個函數a()他的功能和意義在沒有注釋的時候需要別人自己去解讀,假如我已經注釋他是一個冒泡演算法的話,別人就知道他實現的意義了
D. 編程中//注釋怎麼打出來,那幾個鍵啊
不同的編程語言注釋符也不一樣。
// 這是就是 「?」鍵下面"/",按兩下即可
E. 關於各種編程語言的注釋
c
行注釋:none
塊注釋:/*這里是注釋*/
擴展名:.c/.h
c++
行注釋://這里是注釋
塊注釋:/*這里是注釋*/
擴展名:.cpp/.h
vb
行注釋:'這里是注釋
塊注釋:none
擴展名:.bas
java
行注釋://這里是注釋
塊注釋:/*這里是注釋*/
擴展名:.java
.net
dotnet is not a language!
is a platform.
vb.net
行注釋:'這里是注釋
塊注釋:none
xml注釋:///這里是xml注釋
擴展名:.vb
perl
行注釋:#這里是注釋
塊注釋:none
擴展名:.pm
c#
行注釋://這里是注釋
塊注釋:/*這里是注釋*/
xml注釋:///這里是xml注釋
擴展名:.cs
html
行注釋:none
塊注釋:<!--這里是注釋-->
擴展名:.htm/.html
F. 怎樣在三菱PLC編程軟體中插入注釋
1、打開三菱PLC編程軟體的主頁,需要確定一段簡單的程序。
G. 編程的時候什麼樣的注釋方法最好
一般用到的或者說大多數程序員愛用的就是行注釋與塊注釋,行注釋典型的為//,塊注釋典型的為/* xxxxxxx */ 。注釋太多不好,太少更不好,相比來說多比少好,恰當最好。注釋在什麼地方,一般頁頭處,說明該頁干什麼的。函數聲明處,說明函數是干什麼的。其它地方你覺得別人可能看不懂的地方都應注釋一下。
H. 在網頁編程中如何進行注釋
html代碼的注釋格式是:<!--這里寫注釋的內容(不能再出現「--」,否則容易出錯)-->
腳本或者樣式的(多行)注釋格式是:/*注釋內容寫在這里*/
腳本或者樣式的(單行)注釋格式是://注釋內容寫在這里