标签: documentation

我是一名C/C++程序员,我目前正在玩一些Javascript代码,我在查找文档的位置时遇到问题,浏览器中提供了标准的Javascript库.

具体来说,我onload在a上HTMLImageElement创建了一个回调函数new Image().我还想阅读有关src属性的内容,因为它具有非标准行为 - 当分配此属性时,将重新加载图像.

Mozilla在这里 有各种属性的骨架文档:https://developer.mozilla.org/en/DOM/Image这里没有文档,只有属性列表.该onload物业未被提及.该src物业已列出,但没有相关文件.

MSDN有更好的文档:http://msdn.microsoft.com/en-us/library/cc197055(VS.85).aspx.

我的问题是"标准文档在哪里"？是Image()全局变量,还是window全局对象的属性？谁写的API window和document？是否有标准,或者每个浏览器是否只是相互复制？

在过去一年左右的时间里,我在Clojure讨论列表和其他关于Clojure代码记录工具的地方看到过各种各样的公告.这些包括像Marginalia这样的全面识字编程系统,以及用于创建"小片中的Clojure"(甚至是emacs组织模式)的书籍,以及更常规的Javadoc式解决方案,如Autodoc和Javadoc本身.据报道,可以与Clojure一起使用.一个谷歌搜索出现了各种其他,也许一些值得更多的关注,并且肯定有些只是用于生成文档的个人工具.我的问题是什么是最好的文档工具,根据您使用它们的经验,它们的比较优势和劣势是什么？到目前为止,我还没有使用任何文档工具,并且有兴趣尝试一个或多个.

在我创建一个方法后,我用它/**<enter>来生成DocBlock.它会自动填充@param和@return执行该功能.例:

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

如何自定义生成的块,以便它也可以填充@author并最终生成/**<enter>

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <john@doe.com>
 */
public function strlen($str){
    return strlen($str);
}

谢谢

我正在使用面向对象的MATLAB编写一个相当大的应用程序,这让我想到了如何记录代码.如果这是C,我会使用Doxygen.对于Java,我使用JavaDoc.两者都主要就类和方法文档的外观和应包含的内容达成一致的标准.

但是MATLAB代码怎么样？我在TMW自己的类中看到的最多的是在本课程顶部的一两句话,我找不到任何专门用于记录大型MATLAB应用程序的主题.

那么如何记录您的MATLAB类？任何特定的样式问题或其他工具？

我正在寻找一个用于doxygen代码文档的eclipse插件.我找到了eclox-plugIn(http://home.gna.org/eclox/).我想知道,它怎么能自动生成一个"空"的doxygen注释,可以在以后填写,或者什么是文档eclipse插件的更好选择？

例如对于函数:void f(int p1,int p2,...),它应该生成:

/*! \brief ...
    \param p1 ...
    ..
*/ 

PS我主要用于c/c ++语言

在包含前向声明的头文件中,或在包含实现的.cpp文件中,像这样？

//header.h
/* About foo() */
void foo();
/* About bar() */
int bar();
/* About A */
class A
{
public:
    /* About A's constructor */
    A();
    ....
}

要么

//implementation.cpp
/* About foo() */
void foo()
{
    ...
    ...
}
/* About bar */
int bar()
{
    ...
}
/* About A's constructor */
A::A()
{
    ...
}

我想离线提供一个Windows API参考文档.MSDN很好,但是当我无法访问互联网时,我也需要这种信息.

pdf,chm,help(对于emacs)没问题.

当然我不是第一个想要那个的人,但我找不到任何东西.有人可以指向一个地方找到它吗？

我看到SDK中可能有引用,但安装它需要大约200 MB,我只需要文档.

我正在寻找一个关于PyInstaller的教程,它将解释类似的东西

• 如何创建.pkg文件
• 如何包含/排除模块
• 如何在安装目录中包含数据文件.

从标准的PyInstaller文档中我无法理解.

我需要为我创建的REST API编写一些api文档.是否有工具可以在下划线api文档中找出类似风格的html输出？或者也许某些东西会输出一些作为Twitter引导风格的html？

我看到docco确实编写了代码,但我实际上只是想要记录API.理想情况下,我想在控制器文件中指出一个工具,让它生成有关方法和路由的文档,但不显示任何源代码,除非我特别说出示例.

我正在使用Akka Java API和Eclipse(Kepler Service Release 2)+ Maven.我可以从Java编辑器直接进入scala类,但是我无法在悬停时看到文档(参见示例图片).有没有办法在悬停时包含文档？

悬停时:

它应该显示的文档: