这是非常基本的问题.
我必须为COBOL程序写出数据术语表.此数据词汇表包含有关每个变量的以下详细信息:
我有几个变量,包括88级开关.我的问题是:这些88级交换机是否被视为变量,我应该将它们包含在数据术语表中吗？或者,根据我必须使用的数据词汇表结构判断,在这种情况下是否应该忽略它们？
虽然我在这里,另一个简单的问题.填充程序是否应包含在数据词汇表中？该程序特别包含大量填充变量,大多数是简单的"PIC X"变量.
使用时编译源代码时csc.exe,可以使用/ doc选项将源文件中的xml文档注释保存到外部xml文件中.
我想知道的是编译器为什么在该文件中包含我的代码的非公共成员的xml注释.由于我已经在源代码中有文档,因此在处理该项目时,我不需要xml文档文件中的任何内容.
如果我将dll用于另一个项目,我无论如何都不能使用非公共成员.那为什么它包含所有私人和内部成员的文档？
我还想知道是否有办法防止这种情况发生.
c# compiler-construction documentation documentation-generation xml-documentation
我有一个很好的有关项目的狮身人面像文档，我想扩展它以生成诸如规范等文档。我希望有spec-for-foo.rst产生spec-for-foo.pdf
假设我在doxygen页面中有一个部分page_Examples叫做section_Example.是否可以直接链接到该部分？
链接到页面已完成\link page_Examples Examples \endlink,但我想直接进入该部分!谢谢.
我正在使用带有Markdown的YARDoc来记录我的Ruby代码,并希望在方法的文档中有一个无序列表(HTML"项目符号").这是我到目前为止所拥有的:
$ cat file.rb
class Foo
# Returns "foo", which consists of the letters:
# * f
# * o
# * o
def method; "foo"; end
end
我正在使用以下方式生成文档:
$ yard doc --markup markdown file.rb
但它不会生成HTML项目符号,它会将星号(*)视为文字字符.生成的doc/Foo.html文件包含:
<span class="summary_desc"><div class='inline'><p>Returns "foo",
which consists of the letters:
* f
* o
* o.</p>
</div></span>
如何在YARD中使用Markdown插入HTML项目符号？我基本上希望将上面输出中的每个字母都包含在内<li>...</li>,并将列表包含在一个<ul>元素中.
我如何记录此小部件,以便工具包可以公开方法和选项.
我尝试的所有东西都不会在封闭内部看到任何东西.
/**
* @fileOverview
* @version 1.0
*/
(function($) {
"use strict";
$.widget('mynamespace.nameofwidget', {
// foo should show up in the docs
options: {
'foo': 'bar'
},
// public function name and parameters should be documented
myPublic function () {
// code here....
},
// private function no need to document
_create: function () {
// code here....
},
// private function no need to document
_setOption: function (key, value) {
// code here....
},
});
})(jQuery);
[编辑]
这是我的配置文件 …
我正在使用Yard生成文档,但即使在我运行时yardoc --private,它也没有显示源中私有方法的文档.
怎么了？
我想用CodeDOM生成C#代码文档.
没有文档的代码:
public class MyType {
public static BitmapImage File {
get { return GetFile("..."); }
}
}
代码与文档:
/// <summary> Gets the File from the location </summary>
public class MyType {
public static BitmapImage File {
get { return GetFile("..."); }
}
}
要么
/// <summary>
/// Gets the File from the location
/// </summary>
/// <param name="path"></param>
/// <returns></returns>
public class MyType {
public static BitmapImage File {
get { return GetFile("..."); }
} …希望它属于这里.
我的默认浏览器是chromium和球拍raco docs无关 - >无论如何都启动了firefox.一点谷歌搜索并man raco显示没有相关的设置.甚至有点尴尬地问.但我几年前依旧回忆起我之前racket安装的同样问题.
由于没有明显的设置,它可能不是ubuntu特定的(虽然决定标记).毕竟浏览器似乎是帮助默认模式.