標簽[ndoc] - 堆棧內存溢出

[英]Simplest way to add XML doc to a WinRT project

我們有一組開發人員從C ++遷移到C＃和WinRT。我們使用D'Oxygen作為C ++開發人員構建的一部分，我希望繼續將文檔生成作為C＃/ WinRT中開發人員構建的一部分。很容易打開XML Doc生成，我相信這會為格式錯誤的標簽提供警告，但是如果沒有實際的HTML輸出，我認為我們 ...

[英]Ndoc on properties best practice?

我的項目經理上周暗示要在類中的屬性上使用ndoc。這是應該做的事情嗎？是否認為這樣做是最佳做法？我目前正在擴展我正在研究的項目部分的所有ndoc，但不知道我需要進行多深的學習。我當然已經為類和每個方法提供了摘要，參數，返回值和注釋，但是屬性也需要ndoc嗎？ ...

[英]NDOC Error building documentation.

使用.NET Framework 3.5，我具有支持框架3.5的nant -0.91-alpha2，但是在嘗試構建文檔時出現以下錯誤。該文檔將通過以下方式生成： ...

[英]How can I link to MSDN/official documentation from my C# XML documentation comments?

給定 XML 對 class 的評論，如下所示：如何獲取對System.Threading.Thread.CurrentPrincipal和System.Web.HttpContext.User的引用以鏈接到框架文檔中的相應頁面？ ...

[英]What Are Best Practices For Documenting C# code with XML comments?

我正在編寫一些我剛編寫的新代碼，並將NDoc sytle注釋添加到我的類和方法中。我希望生成一個非常好的MSDN樣式文檔供參考。一般來說，在為類和方法編寫注釋時，有哪些好的指導原則？ NDoc評論應該說什么？他們應該怎么說？我發現自己正在研究.NET框架評論所說的內容， ...

[英]Documentation with NDOC3

我正在使用NDOC3處理項目文檔。嘗試記錄第三方DLL時，構建失敗（因為我沒有針對它們的xml文檔）。我該如何解決這個問題？ ...

[英].NET xml docs - inheriting documentation

NDoc有一個XML元素inheritdoc ，它允許您從父類（或實現的接口）繼承成員的文檔。但是，Visual Studio（即C＃編譯器）不理解此標記並抱怨文檔不存在或完整。 StyleCop和其他一些工具也是如此。有替代方法嗎？你如何保持文檔完整，但沒有重復XML描述？ ...

[英]Code documentation: How much is too much?

您的.NET源代碼文檔中有多少是太多了？一些背景：我繼承了一個很大的代碼庫，我已經在SO上發布了一些其他問題。這個代碼庫的一個“特性”是God Class，一個包含大約3000行代碼的單個靜態類，包含幾十個靜態方法。它是從Utilities.CalculateFYBasedOnM ...

[英]HelpInsight documentation in Delphi 2007

我正在使用D2007並嘗試使用HelpInsight功能（自D2005以來提供）來記錄我的源代碼。我主要想讓HelpInsight工具提示工作。通過各種網絡沖浪和實驗，我發現了以下內容：使用三斜杠（///）注釋樣式比其他記錄的注釋樣式更常用。即： {*! commen ...