如何將參考註釋添加到您的XML代碼

通過這個循序漸進的指南獲取事實

如果您有興趣將參考註釋添加到您的XML代碼中,請使用此分步教程獲取指導。 您可以學習如何在短短五分鐘內執行此功能。 雖然這個過程很容易完成,但在開始之前,您仍應該了解一些關於XML註釋及其用途的基礎知識。

為什麼XML註釋有用

XML中的註釋與HTML中的註釋幾乎相同,因為它們都具有相同的語法。 使用註釋可以讓你理解你以前寫過的代碼。 它還可以幫助正在審閱您開發的代碼的其他開發人員了解您所寫的內容。 簡而言之,這些評論為代碼提供了上下文。

通過評論,您可以輕鬆留下筆記或暫時刪除部分XML代碼。 儘管XML被設計為“自我描述數據”,但有時您可能需要留下XML註釋。

入門

註釋標籤由兩部分組成: 開始評論的部分和結束部分。 首先,添加註釋標記的第一部分<! - 然後寫出您想要的任何評論 。 只要確保你不要在其他評論中嵌套評論(更多細節參見提示)。

之後,您將關閉評論標籤 - >

有用的提示

在向XML代碼添加引用註釋時,請記住它們不能位於文檔的頂部。 在XML中,只有XML聲明可以優先:

<?xml version =“1.0”?>

如上所述,評論可能不會嵌套在另一個之內。 在打開第二個評論之前,您必須關閉您的第一條評論。 另外,標籤內不能出現註釋,例如

切勿在評論的開頭和結尾使用兩個破折號( - )。 註釋中的任何內容對XML解析器來說都是不可見的,所以要非常小心,仍然有效並且格式良好。

包起來

如果您仍然有關於向XML代碼添加參考註釋的問題,您可能需要閱讀一本書,以便詳細了解該過程的工作原理。 諸如Rod Stephens的C#5.0程序員參考書籍可能會有幫助。 查看網上零售商或當地圖書館是否有類似的書籍。