[英]Build XML documentation by code
我嘗試為Visual Studio編寫一個適用於XML代碼文檔的插件。 但是我創建XML的代碼無法正常工作:
XElement rootElement = new XElement("doc");
XElement summaryElement = new XElement("summary");
var refElement = new XElement("see");
refElement.Add(new XAttribute("cref", codeFunction.Name));
summaryElement.Value = string.Format("Initializes a new instance of the {0} class.", seeRefElement);
rootElement.Add(summaryElement);
comment = rootElement.ToString();
這是輸出。
<doc>\\r\\n <summary>Initializes a new instance of the <see cref="Form1" /> class.</summary>\\r\\n</doc>
它應該是:
<doc>\\r\\n <summary>Initializes a new instance of the <see cref="Form1" />class.</summary>\\r\\n</doc>
我應該使用另一種方式來創建XML嗎?任何提示和改進都是值得的。
替換下一行
summaryElement.Value = string.Format("Initializes a new instance of the {0} class.", refElement);
同
summaryElement.Add(new XText("Initializes a new instance of the "));
summaryElement.Add(refElement);
summaryElement.Add(new XText(" class."));
是的,它自然會轉義<。 關於此的其他地方有一個線程,其中包含一些建議的解決方法:
從摘要XML生成API文檔的最簡單方法是使用Sandcastle。 請參閱此線程以獲取鏈接: 是否有任何好的自動化工具來記錄REST API
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.