C 注釋語法

2021-05-24 10:06:28 字數 1233 閱讀 5782

注釋語法

為了使用c#提供的xml注釋功能,你的注釋應該使用特殊的注釋語法(///)開頭。在///之後,你可以使用預先定義的標籤注釋你的**,也可以插入你自己定義的標籤。你定製的標籤將會在隨後加入到生成的注釋文件中。

預定義的標籤用處

將說明中的文字標記為**

提供了一種將多行指示為**的方法

指定使用方法或其他庫成員的示例

允許你指定可能發生的異常類

允許你引用描述源**中型別和成員的另一檔案中的注釋, 使用xml xpath 語法來描述你的源**中的型別和成員。

向xml注釋文件中插入乙個列表

向xml注釋文件中插入乙個段落

描述乙個引數

提供了一種指示乙個詞為引數的方法

允許你將成員的訪問許可加入到文件中

用於新增有關某個型別的資訊

描述返回值

指定鏈結

指定希望在「請參見」一節中出現的文字

型別或型別成員的通用描述

描述屬性

例子

下面的例子為我們常見的helloworld控制台應用程式新增注釋:

using system; 

namespace helloworld  } 

} 為生成xml注釋文件,我們在呼叫csc編譯源**時使用/doc選項:

csc /doc:helloworld.xml helloworld.cs

生成的結果文件如下:

<?xml version="1.0"?>

xmlcomment

sample hello world in c#

command line arguments

status code of 0 on successful run

html頁面

你可能會問自己:我應該如何才能得到具有良好格式的html頁面呢?很簡單,你可以編寫自己的xsl來轉換生成的xml注釋文件,或者使用visual studio.net開發工具。通過使用vs.net的【工具】選單中的【生成注釋web頁】,你可以得到一系列詳細說明你的專案或解決方案的html頁面。下面就是通過vs.net生成的注釋helloworld程式的html頁面快照:

mysql 注釋語法

mysql伺服器支援3種注釋風格 從 字元從行尾。從 序列到行尾。請注意 雙破折號 注釋風格要求第2個破折號後面至少跟乙個空格符 例如空格 tab 換行符等等 該語法與標準sql注釋語法稍有不同,後者將在1.8.5.7,作為注釋起始標記 中討論。從 序列到後面的 序列。結束序列不一定在同一行中,因此...

sql 注釋 語法

mysql 伺服器支援 到該行結束 到該行結束 以及 行中間或多個行 的注釋方格 mysql select 1 1 這個注釋直到該行結束 mysql select 1 1 這個注釋直到該行結束 mysql select 1 這是乙個在行中間的注釋 1 mysql select 1 這是乙個 多行注釋...

sql 注釋 語法

mysql 伺服器支援 到該行結束 到該行結束 以及 行中間或多個行 的注釋方格 mysql select 1 1 這個注釋直到該行結束 mysql select 1 1 這個注釋直到該行結束 mysql select 1 這是乙個在行中間的注釋 1 mysql select 1 這是乙個 多行注釋...