标签: code-documentation

我正在为Unity3D开发一个C#DLL插件.实际上,MonoDevelop工具提示(或Visual Studio)仅显示我的方法的结构:

但它没有像我这样显示我的总结:

即使我记录了我的代码:

有没有办法在DLL中包含我的文档？

解决了这个问题(感谢krillgar)

1:在VisualStudio中构建时创建XML文档文件

2:在Unity3d的Assets/Plugins文件夹中导入此XML

这个in-Xcode文档NSNotFound非常令人困惑:

它说"可在iOS 2.0到8.4中使用"和"可用性:iOS 8.1到8.0".那么...... 它在8.0之前可用吗？还是9.0+？此外,这里发生了什么,如果是的话？

我正在尝试检查来自用户的输入是否与RegEx匹配,[a-zA-z]因此我检查了文档以获取正确的方法.我match?在Ruby-doc.org中找到并将docs中显示的示例复制到irb,但是true我没有得到这个:

2.3.3 :001 > "Ruby".match?(/R.../) 
NoMethodError: undefined method `match?' for "Ruby":String
Did you mean?  match
        from (irb):1
        from /usr/local/rvm/rubies/ruby-2.3.3/bin/irb:11:in `<main>'

为什么这种方法在我的irb中不起作用？

我有时想在我的doxygen评论中提到标准库构造.我可以使用HTML <a>元素执行此操作- 但这是要粘贴的大量文本.我宁愿能简单地写{@ref std::string},并有doxygen的知道它需要链接到cppreference.org 页面的std::string.

我想也许如果有人要为标准库生成一个doxygen标签文件(如果标签文件不支持任意URL,那么这可能不起作用)也许是可能的.那么,还有另一种方法吗？

我在Xcode中开发基于C++的软件,并希望(至少)具有相同的代码文档方便性,就好像我正在为Swift或objc开发一样.

例:

std::string myString("hello");
if (myString.empty()) {
    // do something
}

如果我想知道具体是什么.empty(),我想选择 - 点击该功能并获得文档覆盖,其中包含来自http://en.cppreference.com/w/cpp/string/basic_string/empty的信息,完全如下它适用于objc和Swift.

这怎么可能？

当前输出看起来像这样:

我们向外部客户提供了许多程序集,但并非所有公共API都得到官方支持.例如,由于设计选择不是最佳,有时必须从组件公开公开类型才能使我们的其余代码工作,但我们不希望客户使用该类型.传达缺乏支持的一部分并不是以XML注释的形式提供任何智能感知.

有没有办法有选择地抑制XML注释？我正在寻找除了忽略警告1591之外的其他事情,因为这是一个长期维护问题.

示例:我有一个包含公共类A和B的程序集.A是官方支持的,应该有XML文档.B不适合外部使用,不应记录在案.我可以打开XML文档然后禁止警告1591.但是当我稍后添加官方支持的类C时,我希望编译器告诉我,我已经搞砸了并且没有添加XML文档.如果我在项目级别压制了1591,就不会发生这种情况.我想我可以#cragma跨越整个类,但似乎应该有更好的方法来做到这一点.

我正在研究以JavaDocs方式记录我的代码的方法.

有任何想法吗？

我使用UFT 11.52

到目前为止,我见过NaturalDocs + Perl.

还有其他想法吗？

提前致谢.

在c＃块注释中，我想说的是，特定参数的默认值是类const属性。有没有办法直接引用该参数？

我想在生成的文档中显示值，或以某种结构化方式链接到该属性。

这是我要执行的操作的一个示例：

public class Foo
{
    private const int DefaultBar = 20;

    ///<summary>
    ///Does the thing.
    ///</summary>
    ///<param name="bar">Description of bar. Defaults to [[DefaultBar]]</param>
    public int DoTheThing(int bar = DefaultBar)
    {
        return bar;
    }
}

当[[DefaultBar]]以上任何是语法需要引用DefaultBar财产。

因为它是一个常量，所以我认为应该有一种方法可以在生成的文档中对其进行引用，而无需手动使其保持同步。（如果以后要更改为其他int，我不想只替换[[DefaultBar]]为）2020

我查看了C＃“常量对象”作为默认参数，但是该问题（以及相关的答案）没有提出文档。

我知道的很少。方括号[option]用于指示可选参数。例如function(param1 [, param2])表明这param1是必需的并且param2是可选的。

<something>但是尖括号和--文档中的意思又如何呢？例如;

git config [<file-option>] [--type=<type>] --add name value

是什么--type=<type>意思？

谢谢您的回答

我想使用 YARD 更好地记录此 na\xc3\xafve 记忆方法的返回类型：

# Ensures that given block is only executed exactly once and on subsequent\n# calls returns result from first execution. Useful for memoizing methods.\n#\n# @param key [Symbol]\n#   Name or unique identifier of the method that is being memoized\n# @yield\n# @return [Object] Whatever the block returns\ndef memoize(key, &_block)\n  return @memos[key] if @memos.key?(key)\n\n  @memos[key] = yield\nend\n

注意：@memos此类的#initialize方法上正在初始化一个空哈希。

现在，很高兴表达该方法始终返回给定块返回的任何内容，但我不确定如何最好地做到这一点。我想过使用@yieldreturn，但随后需要像泛型这样的东西来表达类似的东西：

# @yieldreturn [<T>]\n# @return [<T>] Whatever …