xml-documentation

0熱度

1回答

我正在解析將/doc作爲編譯器選項傳遞時生成的XML文件。我們以前一直在使用VSDocman來處理解析和文檔網站生成以及自定義主題。我們最終並不喜歡VSDocman生成的網站，但想要用MVC做更強大的功能。解析XML文件非常簡單，但我還想將我可以在VSDocman中定製的主題添加到XML文件中。這在Visual Studio中的內置文檔支持中是不可能的嗎？我是否必須創建一個自定義XML文件來管理

2熱度

1回答

Visual Studio XML文檔參數名稱值顏色

1）是否有人請告訴我XML文檔參數名稱的值的正確術語？即在我的代碼片段的第2和第3行，我叫「iNum1」和「iNum2」是什麼？ 2）在Visual Studio中，有沒有辦法讓它們停止與我的標識符相同的顏色？我所有的評論都是綠色的，除了那些東西;他們是白色的（像我標識符）:-( 謝謝。 PS我使用Visual Studio 2015年

9熱度

1回答

如何在編寫xml文檔時在方法摘要中引用方法參數？

假設我有一個方法如下： /// <summary> /// Here I want to reference the parameter <see cref="personId"/>. /// </summary> /// <param name="personId"> /// The person id. /// </param> //

0熱度

1回答

爲什麼從發佈構建中排除XML文檔如此困難？

每次我使用發佈版本發佈Web部署包時我調用Web API時會出現此錯誤; HTTP 500內部服務器錯誤找不到文件 'C：\ SolutionDir \ PROJECTDIR \ BIN \ AssemblyName.xml' 這裏是我部署到服務器時執行的步驟。在Visual Studio 2013右鍵單擊項目，然後選擇Publish... 檢查我很高興我的發佈配置文件，然後單擊Publish

7熱度

2回答

XML文檔中的參考運算符

我想引用<see cref="..." />XML documentation標記中的運算符，但似乎無法找到有關如何執行此操作的提示。該標籤上的MSDN article僅顯示引用方法的簡單示例，但不涉及可引用的不同類型的成員。特別是，我想引用一個隱式轉換運算符，但引用運算符的一般規則也將被讚賞。例比方說，我們有一個簡單的結構，我們將其定義==，!=和隱式轉換操作符： public struc

0熱度

1回答

我可以將Web鏈接添加到XML文檔中嗎？

Here我看到了允許用於生成文檔的XML標籤集（通過SandCastle）。 Wether是否存在用於鏈接（到網頁）的附加XML標籤，當用戶按下它時，它將通過瀏覽器打開？如果我使用<a href="...:/>，則CHM文件嘗試在其窗口中打開鏈接，並收到腳本錯誤消息。

0熱度

1回答

存在切換文檔的目標XML文件的簡單方法嗎？

在Sandcastle生成的XML註釋的基礎上生成文檔。我想生成英文和俄文版本的文檔。我的XML文件Magic.doc.enu.xml和Magic.doc.rus.xml位於同一個項目（目標dll）。例如，我可以做到這一點通過這樣醜陋的方式： namespace HelloDocs { #if ENU /// <include file='Magic.doc.enu.xml'

0熱度

1回答

Docfx API參考 - 未解決請參閱標記

我按照此tutorial爲類庫創建API文檔。在我的類庫的評論中，我們使用參見標籤來引用其他類型。例如，這是一種含有擴展方法的一類用於System.Action註釋： /// <summary> /// Class containing some extension methods for <see cref="Action" />. /// </summary> public sta

2熱度

1回答

XMLCOMMENTS中的模型參數描述

我正在使用Swashbuckle 5.5.3和使用XMLComments定製的API文檔。我已經提供了未在API文檔中編輯過的模型屬性的描述。示例代碼： /// <summary> /// SomeDetails. /// </summary> /// <param name="Model">SomeDetails.</param> /// <param name="Model.User

0熱度

1回答

在xml文檔代碼中處理自定義xml元素註釋MSDN樣式幫助文件

我正在尋找一種方法來構建包含大型項目的自定義XML元素的幫助文件。我想添加我自己的元素，類似於Summary元素，並讓幫助文件包含它。我安裝了Sandcastle和Ghost Doc Pro。我一直無法找到一種方法來幫助文件構建者添加我的自定義標籤。舉個例子： /// <summary> /// the summary /// </summary> /// <cus