將 GhostDoc 文檔移至<include>標記文件</include>
[英]Move GhostDoc documentation to <include> tag file
所以我有 GhostDoc Pro 並自動記錄了一個項目。 偉大的。 結果是，正如 C# 文檔中所說，與代碼相比，所有這些都比較冗長。 因此，我想為文檔使用 包含標簽和一個單獨的文件，以減少我的類的文檔負擔。 所有類都是自動記錄的，但文檔進入 class 包含文件，如下所示： 和另一個 class ...
GhostDoc如何獲取屬性的屬性？
[英]GhostDoc how to get attributes of a property?
我在Visual Studio 2017上使用上述文檔工具。 我可以進入GhostDoc選項>規則>屬性模板並自定義代碼。 我有類似的財產； 我想訪問“ Required”和“ DisplayName”屬性，並在摘要中使用它們。 有什么辦法可以做到？ 謝謝。 ...
Ghostdoc“記錄此”快捷方式不起作用
[英]Ghostdoc 'document this' shortcut not working
我正在使用Visual Studio 2017社區版V15.8.4和Marketplace（內部版本2018.1.18330）中可用的最新Ghostdoc版本。 自上次更新以來，Ghostdoc不再識別任何分配的快捷方式。 只要分配了Ctrl + Shift + D以外的任何快捷鍵，在' ...
Ghostdoc 不會嘗試生成返回信息
[英]Ghostdoc doesn't attempt to generate return information
我注意到 Ghostdoc 似乎從未嘗試生成退貨文檔。 給定一個這樣的方法： 我希望它像這樣填充退貨信息： 我看過這個，但是這已經很老了，老實說，我真的不明白。 有任何想法嗎？ 顯然，它永遠不會是完美的，但有總比沒有好。 ...
如何從GhostDoc規則中刪除XML注釋元素？
[英]How to remove XML comment element from a GhostDoc rule?
我不想記錄C＃屬性的<value>元素。 但是，GhostDoc被配置為完全做到這一點。 我認為通過訪問配置屏幕並僅刪除元素將其刪除很容易。 但是，沒有按鈕或右鍵單擊上下文菜單可以執行此操作。 按DEL在這里也不起作用。 有什么建議或想法嗎？ ...
GhostDoc“將此文檔記錄”不適用於具有屬性的方法
[英]GhostDoc “Document this” not working for method with attribute
我正在使用GhostDoc和Visual Studio 2017。 現在，如果我有這樣的方法 public string Foo() { ... } 我通常可以使用GhostDocs“將此文檔記錄”為相關方法生成XML注釋。 但是，如果該方法具有任何應用的屬性，例如 [No ...
如何獲取GhostDoc來正確記錄接口實現？
[英]How can I get GhostDoc to properly document interface implementation?
一年前，我在Visual Studio 2015中使用了Ghostdoc Free，非常喜歡它的功能，因此決定購買它。 現在，我必須使用Visual Studio 2012，並且注意到對類的注釋不如以前。 現在它只是說： /// The ClassName class. 而在 ...
Ghostdoc創建一個幫助文件夾，但沒有.chm文件
[英]Ghostdoc creates a help folder, but no .chm file
我已經安裝了Ghostdoc企業版和Visual Studio 2017擴展版。 我已經安裝了htmlhelp。 每次通過cmd或Visual Studio本身構建幫助文檔時，都會創建一個幫助文件夾，但該文件夾為空，而應該有一個.chm文件。 似乎沒有錯誤，只有“找不到文檔的API” ...
我可以得到有關丟失的XML文檔的報告嗎
[英]Can I get a report on missing XML documentation
我正在嘗試GhostDoc，StyleCop，CodeIt.Right，FXCop等，以找到一種簡化的方式來添加C＃代碼中的自動生成的XML注釋以及在例如參數更改的情況下更新現有注釋。 GhostDoc Pro似乎運行良好，但無法獲得覆蓋率報告，或者至少無法完全缺少文檔的類。 我如何 ...
如何僅使用GhostDoc記錄子文件夾？
[英]How can I only document a subfolder with GhostDoc?
我正在嘗試在GhostDoc中構建一個HelpFile。 它僅使我可以選擇記錄整個項目。 我只想記錄一個項目中的子文件夾。 我怎樣才能做到這一點？ 我看不到選擇子文件夾的選項。 如果我右鍵單擊一個項目，則不會顯示任何選項。 有人知道如何只記錄子文件夾嗎？ ...
處理MSDN樣式幫助文件的xml文檔代碼注釋中的自定義xml元素
[英]Process custom xml elements in xml document code comments for MSDN style Help files
我正在尋找一種構建包含大型項目的自定義XML元素的幫助文件的方法。 我想添加自己的類似於Summary元素的元素，並包含幫助文件。 我已經安裝了Sandcastle和Ghost Doc Pro。 我無法找到一種方法來使這兩個幫助文件構建器都包含我的自定義標簽。 一個例子： 如果有 ...
Ghostdoc無法正確處理帶下划線的大寫常量
[英]Ghostdoc not handling upper case constants with underscores correctly
當遇到包含下划線的const ，Ghostdoc似乎變得非常困惑。 拋開常量是否應該采用這種格式，在我看來，這可以更好地處理。 我在下面提供了一個示例： 除了重構所有常量之外，是否還有一種方法可以強制Ghostdoc處理這些常量？ 我沒有看到任何似乎可以滿足要求的選項。 ...
GhostDoc Context.CurrentCodeElement.HasBaseTypes始終返回false
[英]GhostDoc Context.CurrentCodeElement.HasBaseTypes always returns false
關於如何使用Ghost Doc獲取類的基本類型的任何想法？ 根據當前類繼承的基類，我想自定義當前類的摘要注釋。 這是我到目前為止的內容： ...
將登錄名添加到GhostDoc生成的幫助網站
[英]Add Login to GhostDoc generated help website
我有一個帶有XML注釋的項目，並且按預期生成了文檔，但是我的老板希望將文檔本身放在登錄后，以便不能隨意訪問。 我可以通過添加登錄頁面並在IIS中進行設置來做到這一點嗎？ 或者，我是否必須在每個單獨的頁面中添加一些內容以強制進行操作，以確保有人登錄並有權查看該文檔？ 或其他？ ...
如何停止GhostDoc在行尾添加標點符號
[英]How to stop GhostDoc adding punctuation to the end of the line
盡管GhostDoc有很多類似之處，但我從未喜歡過這樣一個事實，它會在標記中的每個注釋末尾添加句號。 是否有黑客可以關閉此功能？ 我說“ hack”是因為我已經檢查了選項，但看不到任何看起來有幫助的東西。 我正在運行4.9.15086版本 ...
C＃評論模板
[英]C# Comment Template
會有人碰巧知道您是否可以為c＃中的注釋創建自定義模板嗎？ 我使用了RME樣式的修改，而不是本節。 不幸的是，我沒有專業的doc訂閱。 我希望它像Visual Studio一樣工作，在其中鍵入“ ///”並創建注釋模板。 我曾看到類似的問題說您無法執行此操作，但它們的日期為2010年， ...
解決XML文檔注釋難題
[英]Solving the XML doc comment dilemma
關於C＃代碼中的XML文檔注釋，有兩種思路： 羅伯特·馬丁（Robert C. Martin）的“清潔代碼”方法 類，方法和變量來表達您的工作意圖， 您不需要評論。” 您需要注釋每個公共類，接口，方法和屬性 由於程序員很懶，因此許多人使用GhostDoc或Res ...
如何記錄解決方案中沒有的文件？
[英]How to document a file that is not in a solution?
我需要在不是.NET解決方案一部分的* .cpp代碼文件中記錄方法/功能。 到目前為止，我的解決方法是創建一個解決方案，但這對於我遇到的所有不同文件都是一個耗時的步驟。 有誰知道如何做到這一點？ ...
使用GhostDoc刪除第一個參數字符
[英]Remove first parameter character with GhostDoc
我有一些類似pOtherColor的參數。 使用ghostdoc，我得到“ The p Other Color”。 宏是$（Name.Words.TheAndAllAsSentence） 有一個宏ExceptFirst-但這給出了“其他顏色”。 我需要的是一個類似於“ TheAndE ...
是否可以從BaseClass繼承抽象方法體中的注釋？
[英]Is it possible to inherit comments in an abstract method's body from a BaseClass?
我有PersonBaseClass和派生自它的EmployeeClass。 現在我想在BaseClass中將方法體定義為注釋，當我使用Resharper的“實現成員”（或手動實現它們）時，它也將它放在方法體中。 某事（大致）是這樣的： 實施時看起來像這樣： 那已經可能了嗎 ...