如何让GhostDoc正确地记录接口实现？
GhostDoc是一款用于自动生成代码注释的工具，它可以帮助开发人员快速生成接口、类、方法等的注释文档。要让GhostDoc正确地记录接口实现，可以按照以下步骤进行操作：
- 配置GhostDoc：在使用GhostDoc之前，首先需要进行一些配置。可以打开GhostDoc的设置界面，根据自己的需求选择适当的配置选项。例如，可以设置注释文档的模板、注释文档的语言、注释文档的格式等。
- 选择接口实现：在代码编辑器中找到要记录注释的接口实现代码块。可以使用鼠标选中整个接口实现代码块，或者使用快捷键选择。
- 执行GhostDoc命令：执行GhostDoc的命令来生成注释文档。可以使用快捷键，或者在编辑器的菜单栏或工具栏中找到GhostDoc的命令按钮。点击命令按钮后，GhostDoc会自动分析选中的代码块，并生成相应的注释文档。
- 检查和修改注释文档：生成的注释文档可能不完全符合需求，需要进行检查和修改。可以阅读注释文档，确保其准确描述了接口实现的功能、参数、返回值等信息。如果需要修改注释文档，可以直接在注释文档中进行编辑。
- 保存注释文档：完成注释文档的检查和修改后，记得保存注释文档。可以使用编辑器的保存功能，或者使用GhostDoc提供的保存命令。
总结起来，要让GhostDoc正确地记录接口实现，需要配置GhostDoc，选择接口实现代码块，执行GhostDoc命令生成注释文档，检查和修改注释文档，最后保存注释文档。这样可以提高代码的可读性和可维护性，方便其他开发人员理解和使用接口实现。
相关·内容
我使用的是Visual Studio 2017 Community Edition V15.8.4和Marketplace中提供的最新Ghostdoc版本(Build 2018.1.18330)。 自上次更新以来，Ghostdoc不再识别任何指定的快捷键。每当分配了Ctrl+Shift+D以外的任何快捷方式，Ghostdoc都会在“Document This”上显示“Ghostdoc注意到您没有与Document This关联的快捷方式。是否要重新分配Ctrl+Shift+D快捷方式？” 如何分配快捷键并不重要(工具、=>选项、=>键盘或Ghostdoc重新分配快捷键)。如果我使
浏览 21提问于2019-02-05得票数 0
2回答
当涉及到StyleCop的时候，我是异常的肛门。我喜欢确保类库布局良好，可维护，并有适当的文档记录。
例如，我创建了一个接口：
public interface ICustomImpl
{
/// <summary>
/// Say hello!
/// </summary>
void SayHello();
}
然后实现我的接口
public class Hello : ICustomImpl
{
public void SayHello()
{
//impl
}
}
StyleCop现在会抱怨我
浏览 2提问于2014-04-19得票数 0
回答已采纳
我非常喜欢Visual的XML注释。我想知道是否有一种特殊的方法来注释继承的基本方法，比如Equals()和GetHashCode()，以便接管对象类的描述。
例如，MSDN刚刚说
确定指定的对象是否等于当前对象。(从对象继承)
所有Equals()的发生。我可以对XML注释做同样的操作吗？
谢谢
浏览 3提问于2012-05-23得票数 1
回答已采纳
我不想记录C#属性的<value>元素。但是，GhostDoc的配置正是为了做到这一点。我认为通过访问配置屏幕并只需删除元素就可以很容易地删除它。但是没有按钮或右键单击上下文菜单来执行此操作。按DEL键在这里也不起作用。有什么建议或想法吗？ ?
浏览 27提问于2019-01-11得票数 3
回答已采纳
我正在使用GhostDoc和VisualStudio2017。
现在，如果我有这样的方法
public string Foo() { ... }
我通常可以使用GhostDocs "Document this“为相关方法生成XML注释。
但是，如果该方法具有应用于它的任何属性，例如
[NotNull]
public string Foo() { ... }
GhostDoc 不能自动将该方法文档化。为什么会这样呢？由于我所有的方法都有注释，所以不能使用GhostDoc并不太舒服。
GhostDoc可以用属性来记录方法吗？
顺便说一句:我尝试通过在属性和方法之间插入///
浏览 0提问于2018-05-02得票数 0
回答已采纳
9回答
有没有在接口和实现之间自动同步注释的方法？我目前正在记录它们，不想手动将它们保持同步。
更新：
考虑下面的代码：
interface IFoo{
/// <summary>
/// Commenting DoThis method
/// </summary>
void DoThis();
}
class Foo : IFoo {
public void DoThis();
}
当我像这样创建类时：
IFoo foo=new Foo();
foo.DoThis();//comments are shown in intellise
浏览 1提问于2009-05-05得票数 102
回答已采纳
有没有办法让ghost doc修改方法(由Ghost doc生成)的现有XML注释，以便在方法上运行它时添加"modified by“行？
我个人认为这就是源代码控制的目的，但他们希望在XML中完成，所以这是一个新的工作要求。
浏览 0提问于2012-05-25得票数 1
回答已采纳
我已经在netbeans中创建了现有服务的web服务客户端，ide正确地实现了所有面向对象的样式，但我需要记录xml请求和从服务的响应，如何记录这些信息？
浏览 0提问于2012-10-15得票数 1
回答已采纳
1回答
接口注释和继承
、、
搜索一下，我发现这类问题在 中被提出，但并不针对VS2010或C# .Net 4。有没有人发现一种方法，可以让接口注释继承到实现类中，以便智能感知使用？
一位同事建议复制并粘贴到实现中，但肯定有更好的方法。看一下前面的问题推荐，Sandcastle似乎是一个文档生成器，这不是我所需要的。
请考虑以下几点：
public interface IFoo
{
/// <summary>
/// Comment comment comment
/// </summary>
string Bar { get; set; }
}
public cl
浏览 3提问于2011-01-26得票数 0
回答已采纳
2回答
我想知道是否有某种方法可以做到这一点，或者是否应该这样做？我的想法很快转向使用方法属性，因为它是一种元数据，但我不确定是否有用于此目的的属性。现在，我只是简单地使用<remark>注释标记来判断某个方法何时实现了某个接口。但这当然不是元数据的结构化形式。
也许自动化的代码文档系统已经可以通过代码解析这些信息，但对于任何阅读实际代码的人来说，它仍然很有用，以便更容易地理解它。
浏览 0提问于2010-03-30得票数 0
回答已采纳
1回答
我正在尝试在GhostDoc中构建一个HelpFile。它只为我提供了记录整个项目的选项。我只想在项目中记录一个子文件夹。我该怎么做呢？
我看不到选择子文件夹的选项。如果我右键单击某个项目，则不会出现任何选项。有人知道如何只文档子文件夹吗？
浏览 11提问于2016-06-16得票数 0
2回答
我想记录我的VB.NET网站的源代码。
如何将VB.NET ASP.NET网站中的XML注释转换为XML文档文件？
我看不到在VS网站的属性页中生成XML文档文件的选项。
浏览 4提问于2014-02-24得票数 1
回答已采纳
4回答
如何复制.NET接口文档？
、、、、
如果类实现了接口中定义的方法，则可以选择是复制文档还是使用<see cref="..." />引用它。
public interface IPerformer
{
/// <summary>
/// Do something useful.
/// </summary>
/// <param name="something">Object to do something with</param>
void Do(Something something);
}
p
浏览 0提问于2011-06-01得票数 7
回答已采纳
我们正在管理一个C++/C#库，我们注意到许多类和函数都没有文档化。
我们考虑编写一个脚本，它将解析代码以查找未记录的类和方法，以生成未记录的类/方法/函数的列表。
我们也希望这个脚本能够将dOxygen标记放在缺少文档的地方。即，如果找到这样一段代码：
bool Myclass:undocumentedMethod(int a);
它将被替换为
/// \brief <DESCRIPTION>
/// \param a <DESCRIPTION>
/// \return bool <DESCRIBE RETURN VALUE>
bool Myclass:u
浏览 0提问于2009-12-15得票数 0
回答已采纳
1回答
我试图使用类型记录泛型和继承相结合，但是我无法理解为什么下面的代码会导致错误。
interface One {
// something here
}
interface Two extends One {
method<T extends One>(val: T): void;
}
class Three implements Two {
method(val: Three): void {
// do something with val
}
}
知道它为什么会导致错误以及如何正确地实现它吗？
浏览 2提问于2017-12-02得票数 1
回答已采纳
我需要在不属于.NET解决方案的*.cpp代码文件中记录方法/函数。到目前为止，我的解决方案是创建一个解决方案，但对于我遇到的所有不同文件来说，这是一个耗时的步骤。
有谁知道如何做到这一点吗？
浏览 22提问于2015-07-23得票数 0
我的问题是：
我有一个接口，需要它的实现来实现一个静态方法，即void load()。然而，在Java 8之前，我们似乎不会在接口中获得静态方法。我相信我的用户仍然正确地实现它，但我的问题是如何编写一个适当的文档。
这个接口有多达50个实现，无法继承javadoc是一个麻烦。
在我的情况下，最好的方法是什么？我应该记录一个随机实现并在其他实现中添加@see注释吗？我觉得很脏。
任何建议都是欢迎的。
浏览 0提问于2013-06-18得票数 3
回答已采纳
奇怪的问题。我正在使用微软的Sandcastle从我的C#代码中的XML注释生成文档。我的几个类正在实现接口，它们已经有了注释方法。我不希望在接口方法和公共实现的方法中都重复文档。有没有某种标记可以用来从接口“继承”这个文档？
浏览 3提问于2009-04-06得票数 13
回答已采纳
2回答
我有一个超过100个C#类的项目，并希望为每个变量，属性和方法生成文档。在Visual Studio macOS IDE中，您可以使用///一次为一个方法执行此操作，但对所有类执行此操作是非常困难的。
有没有可能在Xamarin Studio/Visual Studio for Mac中实现自动化？如果没有，有没有IDE可以让我这样做？
我不想要一个捆绑文档的程序(如Doxygen)，我想要添加内联文档的东西，我将自己添加文档(或编辑自动生成的文档)。
浏览 14提问于2017-02-23得票数 4
回答已采纳
2回答
对于Visual是否有更好的添加功能来更快地记录代码？
如果有关系的话，我要用的是溢价。
我知道上面的“/”自动生成XML注释，但是是否有一种方法可以向存根或其他快捷方式添加其他信息，以提供关于方法、类和/或程序集的更多文档帮助？
我正在为我的团队开发一些开发标准，如果可能的话，我想让他们的生活变得更容易。
我们将使用沙堡生成最终的帮助文件。
浏览 4提问于2015-01-13得票数 0
回答已采纳
3回答
我正在创建一个小型Java框架，它将记录它的事件。我不希望框架依赖于任何特定的日志实现(、、、、等)。相反，我想让我的客户选择他们喜欢的任何东西。
问题是-我应该如何实现这种解耦？我的框架应该如何记录它的事件？
浏览 3提问于2011-01-08得票数 1
回答已采纳
这是一件让我不时停顿的事情。似乎我需要为sender和e提供一个描述。因为我想不出有什么特别有意义的东西，所以我倾向于删除这两个param元素。
/// <summary>
/// Fired when the destination project is updated.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private
浏览 2提问于2011-06-01得票数 1
回答已采纳
2回答
我有一些想要用UML表示的相关接口和类(抱歉，我不知道如何用StarUML正确地实现)：
实现IMessage和IStorable的接口主义的思想，而不是让SMS类直接实现自己的两个接口，目的是使项目更模块化、更易于维护和更容易测试。
这是一个很好的设计方法吗？如果是这样的话，这是用UML类图表示它们的好方法，还是有更好的方法来表示接口及其与UML中其他接口/类的关系？
浏览 7提问于2020-10-07得票数 3
回答已采纳
我喜欢GhostDoc，但我希望能够对整个文件进行“文档记录”，而不是一次只记录一个成员。这个是可能的吗？
浏览 2提问于2009-10-02得票数 2
回答已采纳
我正在寻找一种方法来建立一个大型项目的帮助文件，其中包括自定义的XML元素。我想添加我自己的类似Summary元素的元素，并将其包含在帮助文件中。我安装了Sandcastle和Ghost Doc Pro。我还没能找到一种方法让这些帮助文件构建器中的任何一个包含我的自定义标记。举个例子：
/// <summary>
/// the summary
/// </summary>
/// <customElement>
/// My custom element contents
/// </c
浏览 12提问于2016-03-23得票数 0
6回答
我有一个接口和一个实现该接口的类。
我有一个要求，那就是类必须依赖于ITimer。创建一个私有成员，传入一个构造函数实参，并将该私有成员分配给该构造函数参数。
如何才能使接口以某种方式声明此ITimer，而不是将其声明为属性？这并不是说我不能正确地测试MyClass，但是我认为接口应该是一个类必须遵守的约定，因此我的类有一个依赖项，那么我如何让它出现在接口中呢？
public interface IMyInterface
{
void DoSomething();
}
public class MyClass : IMyInterface
{
private ITimer MyTim
浏览 2提问于2012-02-21得票数 1
回答已采纳
我正在向一些csharp代码添加注释，并且我使用的是.net (或其他什么)提供的XML语言。我有一个接口和一些实现类。我在接口中有一个方法，它有一个注释。在实现类中，没有关于实现方法的注释。
在java中这样做时，javadoc在生成文档时会自动使用接口注释。但是，现在我构建了我的项目，我收到警告(从瑞典语翻译过来，对不起) "the xml comment for the visible type or member bla.blabla.blablabla() is missing (cs1591)“。这只是一个警告，所以不是很糟糕。但是！这意味着没有输出xml文件，所以我不能使
浏览 4提问于2011-01-10得票数 3
回答已采纳
我写了一些义务和建议，但我想知道是否有一个被广泛接受/或正式的方法来正确地做到这一点？换句话说:在ALFA中是否有标准或首选的使用义务和建议的方式？
我真的很想看到一个例子，如何在一个总是在拒绝和允许上触发(在每个请求上)的分层策略中定义义务(例如，记录每个请求)及其内容？或者，您是否必须为每个策略集/策略和规则定义单独的义务？
您是否必须定义此类义务的确切内容，或者这取决于PEP的功能？
浏览 2提问于2014-12-12得票数 1
我将添加到Web项目中。但是，大多数文档没有显示在帮助页上，因为：
用作参数类型和返回类型的对象在单独的程序集/项目中定义，以及
控制器操作的文档在控制器实现的独立接口中定义。此外，这些接口位于单独的程序集/项目中。
我的解决方案结构概述：
Web项目
带有数据对象的类库(用作控制器操作中的参数类型和返回类型)
带有控制器接口的类库(由每个控制器实现)
帮助页是否有可能( a)将来自不同项目的XML文档合并，以及( b)将XML文档从接口应用到实现它的类上？
浏览 5提问于2016-02-22得票数 2
回答已采纳
5回答
对于简单的getter/setter，像下面这样，记录它的最好方法是什么？
public float getPrice()
{
return price;
}
我对编码标准非常严格，所以我的IDE会警告我任何未记录的公共/受保护的方法。
选项1：
/**
* Get the price field.
*
* @return
*/
选项2：
/**
* @return Price
*/
或者根本不做文档记录？
浏览 0提问于2010-08-30得票数 7
回答已采纳
我有一个库，在那里我想为所有不同的框架创建一个按钮。所有这些组件道具都应该从类型记录界面中获得一个单一的真实来源：
interface BaseButton {
tiny: boolean;
color: string;
}
如何确保根据该接口正确地键入发光元素属性？
@customElement("my-button")
export class MyButton extends LitElement {
@property({ type: Boolean })
tiny = true;
@property({ type: Strin
浏览 3提问于2022-03-25得票数 0
有没有办法让Resharper自动为所有C#函数添加函数头？
例如
/// <summary />
/// <param name="path"></param>
/// <param name="logError"></param>
public FileFormatPluginLoader(string path, Action<string, Exception, bool> logError = null)
如果我至少键入/一次，然后运行代码清理(Ctrl+e，c)，它将创建这些代码
浏览 0提问于2017-01-24得票数 0
如何配置GhostDoc为属性生成注释，如下所示：
[Required(ErrorMessage = "Name is Required.")]
[StringLength(50, ErrorMessage = "Name must be less than 50 characters.")]
public string Name { get; set; }
浏览 3提问于2012-07-26得票数 1
1回答
我已经看到了一些关于不同解决方案的帖子，比如用于记录代码的Sandcastle。然而，我想知道是否有为非开发人员设计的解决方案。像Sandcastle、NDoc或GhostDoc这样的解决方案最适合没有编程背景的普通用户吗？
同时，一旦我开始在网站中实现开发人员工具，我希望最终能够在很远的将来添加一些开发人员的东西。对于帮助系统的轻量级和易于管理的解决方案有什么建议吗？还是说桑德卡斯尔是个好去处？这是一个类似于维基的.net网站。
浏览 1提问于2012-02-29得票数 0
回答已采纳
2回答
考虑到接口现在可以为它提供的方法提供一个实现，我不能正确地理清接口和抽象类之间的区别。有谁知道如何正确地解释这种差异吗？
我还被告知，与抽象类相比，接口的重量要轻一些，性能更好。有人能确认一下吗？
浏览 8提问于2014-04-04得票数 4
回答已采纳
2回答
Asp.Net程序员对如何记录他们的代码有什么偏好？
我用Sand城堡阅读XML是一个很好的方法。你用什么？
浏览 0提问于2011-02-16得票数 0
回答已采纳
1回答
如何自定义GhostDoc以执行以下操作？
///<author>Moo</author>
///<summary>
/// Gets the user by ID.
///</summary>
///<param name=”ID”>The ID.</param>
///<returns></returns>
///<datetime>12/4/2012-11:23 AM</datetime>
基本上，我希望在注释的开头添加作者，并在注释的末尾添加日期时间。
浏览 2提问于2012-12-05得票数 0
回答已采纳
1回答
在一个庞大的项目中，一个很大的错误是没有记录代码，我们想出了为所有方法和类生成一个预定义的摘要的想法，然后每个开发人员在处理一个文件时都应该编辑相应的摘要，如下所示：
/// <summary>
/// undocumented code please change me
/// </summary>
/// <returns></returns>
所以渐渐地，每次开发人员做一些改变都会有改变的反射，是否有办法为每种方法生成这样的摘要，是否有更好的方法来提出建议，谢谢
浏览 3提问于2020-10-27得票数 0
回答已采纳
3回答
我查看了一些接口实现，因为我无法使用“using”关键字来确保正确地在C#中释放一个C#对象，但是编译器给了我这个错误：
“System.IO.FileInfo”：using语句中使用的类型必须隐式转换为“System.IDisposable”
因此，我开始记录这些特定接口的实现。
最后，我看到所有这些都简化为键入:类名旁边的IDisposable，并自己添加一个Dispose()方法，这就是如何生成一个IDisposable。
第一个问题：
这有什么意义？框架创建者不应该让那些项目--一次性/可空/任何你想要的通用界面--而不用我们去担心它吗？
当了两年的程序员，我做了很多年的业余爱
浏览 4提问于2014-10-04得票数 0
3回答
我正在使用Singleton C#在Unity中制作一个游戏，有人警告我，在其他脚本(如C#)中使用类的引用会使代码变得脆弱，很难进行以后的编辑。因此，我寻找如何访问具有接口的单例，但还没有找到我想要的。由于我希望正确地编码，我希望有人向我指出一个不错的来源，告诉我如何这样做，或让他/她告诉我。
浏览 9提问于2017-01-29得票数 1
回答已采纳
对于这个类型记录界面：
export interface Person {
phone?: number;
name?: string;
}
这是否意味着接口类实例上的name属性可以为null或未定义？
例如，提出了一个类似的问题，这表明它使参数是可选的。但是，在接口的上下文中可选意味着什么呢？例如，假设我有一个实现接口的类：
class Customer implements Person {
}
我现在是否正确地实现了Person，因为Person接口上的所有属性都是可选的？
浏览 1提问于2018-02-25得票数 0
回答已采纳
1回答
我的团队正在开发一个插件项目，其中主机应用程序协调插件的工作(每个插件都有特定的功能，并将在单独的线程上执行)。我正在编写主机应用程序并定义IPlugin接口；其他开发人员将参考我的IPlugin接口并开发他们的插件。
在我的团队中有一个问题提出:一些开发人员使用Nlog来记录他们的插件工作，但其他开发人员使用Log4Net。
我的问题是:如何让每个插件都可以使用它喜欢使用的日志记录组件？
谢谢!
浏览 7提问于2015-04-17得票数 0
我刚刚开始使用GhostDoc，所以我希望我的问题不是一个愚蠢的问题。我想通过引用Class1的方法Method1来记录它。因此，我在描述Class1时使用了cref，如下所示。
/// <summary>
/// Use this class to do a lot of things.
/// </summary>
/// <remarks>
/// The most interesting method is <see cref="Method1"/>
/// </remarks>
public class Cl
浏览 17提问于2014-04-16得票数 0
我只是不想让用户手动添加/编辑/删除网格中的任何记录。所有记录都是由程序动态添加的。然而，我希望允许用户通过单击列标题来对记录进行排序。
这个要求真的如此矛盾，以至于不能同时实现只读和排序吗？
浏览 0提问于2015-04-18得票数 0
我要进入类和界面了。我有一件事让我很恼火，这是我第一次在这里处理这些事情。
假设我得到了这个界面：
// IFoo.d.ts
export default interface IFoo {
foo: string;
bar: number;
}
当我在类中实现它时，我执行以下操作：
// FooModel.ts
import IFoo from './IFoo';
export default class FooModel implements IFoo {
foo: string;
bar: number;
constructor({ foo, bar
浏览 7提问于2020-05-31得票数 7
回答已采纳
1回答
我在Windows 8系统上使用Visual 2010。我想更改自动生成的方法头，以包括开发人员名称和当前日期，以保持标题与现有代码的一致性。换句话说，我希望标题类似于以下内容：
''' Author.........: John Doe
''' Created........: 2/15/2007 2:25:30 PM
''' <summary>
'''
''' </summary>
''' <remarks>&
浏览 4提问于2014-02-16得票数 0
回答已采纳
关于如何使用Ghost Doc获取类的基本类型，有什么想法吗？
根据当前类继承的基类，我希望自定义当前类的摘要注释。
到目前为止，这就是我所拥有的：
private string GetClassDescription()
{
string type = string.Empty;
Words words = Context.GetWords(Context.CurrentCodeElement.Name);
string wordsAll = (words == null ? Context.CurrentCodeElement.Nam
浏览 7提问于2016-02-05得票数 0
回答已采纳
我想在ASP.Net页面中响应HTTP POST。
我已经找到了很多发送WebRequest的例子，我可以在我的Page_Load中成功地提取并读取它。
然而，我想在响应中放回一些数据，但我找不到任何如何做到这一点的例子。
实际的需求是让外部站点发布到页面并接收回其记录的GUID。
任何帮助都是非常感谢的。
浏览 0提问于2010-11-10得票数 2
回答已采纳
2回答
如何在函数上输入intellisense信息？对于VS2010上的C#，我只是在函数前面使用了“/”，它会自动生成一个模板。在C++ VS2012上，我无法让任何东西工作。
浏览 1提问于2012-12-24得票数 0
回答已采纳
哪个C# XML文档注释标记用于文字true、false和null
在微软自己的文档中，这些文字以粗体文本显示。例如，属性的文档显示为：
如果的大小固定，则为；否则为false。默认情况是false。
似乎都不适用于这种情况。最好的匹配方式似乎是，但是当文档由呈现时，<c>true</c>以true的形式出现。
然而，使用<b>true</b>与bold产生粗体文本，正如我猜测的那样。但这让我对产生了疑问，与其他文档生成工具(如和 )一起使用标准的HTML是否具有可移植性。
浏览 0提问于2014-01-23得票数 60
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
