xml-documentation

    2热度

    1回答

    我定义一个回调场和事件属性吧: private Action<int, int, TaskCallbackArgs> _callbackEvent /// <summary> /// Provides a callback event for task. /// </summary> public event Action<int, int, TaskCallbackArgs> Call

    5热度

    1回答

    在代码中,我有这样的功能: public static string Join(this IEnumerable<string> strings, string separator) { return string.Join(separator, strings.ToArray()); } ,我想记录。 我想<return>标签说string.Join(separator, st

    0热度

    1回答

    我使用GhostDoc来记录我的方法等等,其工作良好,但它不填写<returns> ... 谁能告诉我,我应该怎么做,即 如果返回所谓的 “角色” 然后 <returns>A role object see <see cref = "UserRole" /></returns> 或简单地 <returns>A role object</returns> 或的对象 <returns>A ro

    0热度

    2回答

    我不得不在项目中使用Google AdWords API,但我有大量的工作,但我对这些文档感到沮丧。例如,我知道一个TextAd标题字段有25个字符的限制,不能有类似的东西!和?在里面。虽然文档没有提及它: http://code.google.com/apis/adwords/docs/reference/v200909/AdGroupAdService.TextAd.html 有没有人知道我在

    8热度

    1回答

    可能重复: How to reference generic classes and methods in xml documentation 我一直在使用的看到CREF标签和它的伟大工程,但现在我需要包括的String []在看到CREF一个通用的清单,但该文档无法正确呈现。 /// <returns>A <see cref="List<string[]>" /> that .......

    0热度

    1回答

    当前体系结构基于WCF服务,该服务从DB填充DTO对象并返回它们。 有些方法返回完整的对象图,有些只有部分。如果完全填充,某些对象图将会非常大 - 所以对于所有情况都不是一种选择。 如何记录DTO对象中有多少属性被填充,哪些不是?这是一个.NET商店,XML注释不能提供足够的灵活性来记录并非始终填充的属性。其他人如何应对这一挑战? 例如:对于客户端,发票对象是相同的,无论它是否具有所有属性。 提出

    6热度

    2回答

    什么是文档依赖属性的最佳方式? 我应该把赛场上的XML文档: /// <summary>Documentation goes here</summary> public static readonly DependencyProperty NameProperty = DependencyProperty.Register(...) 或对物业: /// <summary>and/

    3热度

    3回答

    我在VS 2005下编写了一个C#类库(我知道,现代化,但我们的预算很紧张)。 在我看来,如果我在XML文档中使用“摘要”标签,我的用户可以通过智能感知和工具提示等查看该信息,但不能在Studio的属性窗口中看到该信息。 要在该窗口中获得某些内容,我似乎需要使用[Description("This is it")]属性。 我正确吗?如果是这样,那么它似乎是我需要复制:-( 的描述信息或者,有没有更

    3热度

    1回答

    对于撰写摘要和参数文本,是否有一个最佳实践,你需要了解多少细节,是否使用完整的句子,或者其他什么?我正在寻找一些良好的习惯来建立,因为我开始使用这些更多。谢谢! public class JustinBieber{ private readonly bool HasTalent; JustinBieber(){ HasTalent = false; }

    1热度

    1回答

    我有一个创建DLL的C++项目,我们称之为my.dll。除此之外,我还提供了一个名为my.h的头文件,其中包含从my.dll导出的函数的声明。 my.dll的源代码#包含my.h头文件。我在my.h的函数声明中添加了XML DOC注释,并在cl.exe命令行中设置了/ doc开关。在编译时,每个* .cpp文件都有一个* .xdc文件,但它们都不包含my.h中的XML DOC注释。 看来cl.ex