我有以下Moo课程:
Nem.Ui.Window = new Class({
Implements: [Options, Events],
options: {
caption: "Ventana",
icon: $empty,
centered: true,
id: $empty,
width: $empty,
height: $empty,
modal: false,
desktop: $empty,
x: $empty,
y: $empty,
layout: $empty
},
initialize: function(options)
{
this.setOptions(options);
/* ... */
},
setHtmlContents: function(content)
{
/* ... */
},
setText: function(text)
{
/* ... */
},
close: function(win)
{
/* ... */
},
/* ... */
});
我想用JsDoc记录它.我读过你可以@lends [class].prototype在里面使用new Class并initialize用@constructs标记标记.我如何标记方法和事件？
IE:setHtmlContents应该是一个方法, …
我在Visual Basic中编写.dll.在Visual Studio中编写代码时,如果我执行类似的操作
Console.WriteLine(
它将弹出一个工具提示,其中包含该功能的一些文档.是否有可能在我的function/sub中写一些可以向Visual Studio提供该信息的东西？
谢谢
我以为我会启动一个wiki来链接旧的rails文档,因为"Rails 3是切片面包以来最棒的东西":).Rails 3很棒,但我还没有动摇它.我无法在任何地方找到2.3.5或2.3.8的文档.我能找到的最接近的是:
http://railsbrain.com/api/rails-2.3.2/doc/index.html
给能找到一些好的2.3.x文档的人+1!
我正在使用Sphinx的"手动"文档类,我对Latex输出的外观非常满意,除了页眉.它包含我的论文标题,以及"Release 1".
由于我正在撰写论文而不是文档,因此我显然不需要发布信息.不幸的是,很难找到有关如何定制Sphinx乳胶输出的信息.
有人知道怎么做吗？
我使用doxygen和XML文档注释为我们的框架库创建内部API文档.
Doxygen为每个命名空间创建一个"包".我想知道是否有可能在命名空间级别添加源文档以显示在Doxygen的包视图中？
我为我编写的应用程序开发了一个XML模式.现在我想记录最终用户的有效结构,但是我无法想出任何自然的方法来做到这一点.我见过像xs3p这样的东西,它实际上将xsd架构转换为HTML表示,但这对我来说看起来不是很好的文档; 用户不需要知道关于模式的任何信息,以了解他可以做什么.
任何想法如何记录这个？任何程序/编辑/图形解决方案或我可以构建的概念？
我很好奇Doxygen是否解析了Javadoc的评论？ - 也就是说,doxygen接受类似的东西:
/**
Greet with a "Hello" message.
@param a string containing the name of the person or entity
@ret return a string containing "Hello" and the name of the greeted person or entity.
*/
public String sayHello(string name)
{
return "Hello" + name;
}
还有一件事,是否有更正确的方式来做这些评论,doxygen风格？
哪里可以找到1.5版jQuery的VSDoc文件？
是否有适用于Sitecore的良好API文档？
我的意思是这样的:http://msdn.microsoft.com/en-us/library/system.web.ui.aspx
但对于Sitecore特定的类？
我知道他们的SDN网站,并在那里有一个帐户,但似乎找不到比许多深入描述特定主题的PDF文件更有用的东西(文档包).
谢谢
我正在尝试为多个包生成java文档,所以我有一个index.html,我可以通过编写为单个包生成它们,
javadoc packages/mypackage1/program/*.java
但我不能让它适用于多个包.我尝试使用javadoc @packages但是我得到了
error - cannot read packages <access is denied>
任何想法都会很棒!!