documentation相关内容
我期待在C所有的语法和内置函数的文档,但我找不到任何的网站上线,这似乎像一个最终官方的标准C知识来源。 除了著名的书由Kernighan和Ritchie ,不存在任何在线C规范?也许有,我不知道如何找到它。或者,也许问题是,我完全不知道我要找的。 为您的私人使用的从ANSI(精等标准组织): 解决方案 您可以获取C99标准(1999年ISO / IEC 9899)的PDF副本适度的费用 -
..
我'找一个Eclipse的插件doxygen的code文档。我已经找到了eclox-插件( http://home.gna.org/eclox/ )。我想看看,怎么能自动生成一个“空”的doxygen评论,这可能是后填写或者什么是一个文档Eclipse插件是更好的选择? 例如一个函数:void F(INT P1,P2 INT,......),它应该产生: / *! \\简短... \
..
我很想知道是否有可能在函数的一些意见(C,C ++,JAVA)的方式,可以doxygen的把它们生成的HTML文件。 例如: 函数(...) { do_1(); / ** *调用do_2功能做具体的东西。 * / do_2(); } 解决方案 没有,doxygen的不支持的功能里面的评论机构块。从手册: Doxygen的允许你把你的文档块几乎任何地方(例外是函数体中一个普
..
我使用Doxygen的一些嵌入式C源代码。给定一个.C / h文件对,你把函数原型Doxygen的意见(h文件)或函数定义(.c文件),或者你复制他们在这两个地方? 我在其中的Doxygen警告有关丢失的意见时,我在一个地方记录而不是其他问题;这种预期,或者是我的Doxygen搞砸了? 解决方案 有关公共API文档我的声明,因为这是用户平时看起来第一,如果不使用doxygen的输出。
..
我有多个文件的C程序,所以我有,例如, stuff.c 它实现的一些功能,而的东西。 ^ h 的函数原型。 我应该如何去评论中记录的功能? 我应该在头文件中的所有文档,所有的文档中的 .C 文件或复制这两个的文档?我喜欢后一种方式,但后来我遇到问题,我会在其中一人,而不是其他(更新文档通常一个在那里我做了第一次修改,也就是说,如果我第一次修改的头文件,那么它的意见将反映,但如果我更新的实施,只
..
创建用C公共头文件时,你怎么认为的最佳实践++? 如果头文件不包含,短暂的或块状的文档?我见过的一切,从几乎没有文档(依靠一些外部文档)大规格不变的,有效的参数,返回值等我不知道到底是什么我preFER,大文件是好的,因为你已经始终可以访问它从你的编辑器,在另一方面具有非常简短的文档,一个头文件往往可以显示文本的一两页给出的可能是怎样的一类做一个更好的概述一个完整的接口。 比方说,我去
..
昨天我发现了一些结构的初始化code抛出我要循环。这里有一个例子: typedef结构{诠释第一;诠释秒; } TEST_STRUCT; 无效testFunc(){ TEST_STRUCT测试= { 第二:2, 第一:1 }; 的printf(“test.first =%d个test.second =%d个\\ N”,test.first,test.se
..
我的团队已经开始记录我们的C code。使用doxygen的,要特别注意我们的公共API头。似乎有很大的灵活性,并在doxygen的,这是很大的不同的特殊命令,但是目前还不清楚什么是一件好事,什么是没有试错坏事。 什么是您最喜欢的方式来标记你的code,你有什么必到之处和DO穷人? 请提供您顶级技巧,每回答一个方便的投票。 我期待来定义我们的整个方法的API文档,包括提供一个模板来获得团
..
我不知道我是怎么进入这个状态,但是X code文档窗口已经表现出“跳顶”每当我将鼠标悬停在一个链接中的DOC文件之一的这种奇怪的行为。 例如,我会向下滚动,比方说,一类参考的方法,以及当我悬停在他们中的一个,该文档窗口跳右后卫顶端。 有没有其他人遇到过吗?如果是这样,是否有在X code修复? 同时,在浏览器中打开了文档解决该问题的工作。 解决方案 谢谢你的答复大家! 同时,我刚才
..
我试图完成的官方文档引用关于在值的列表 *最大并发HTTP /每台服务器1.1的连接当前(2011年)的主要浏览器 下面就是我这么远: 的Firefox 4.x的:6( REF丢失的) 火狐3.6.x的: 6 Internet资源管理器的9.x : 6 的Internet Explorer 8.x的:在拨号: 2 ,宽带: 6 的Internet Explorer 7.x的:在拨号
..
我经常发现回答了有关提升的官方文档里面提升的问题,但是,我总能找到到达那里痛苦的 - 通常包括网络搜索和链接下面的线索,或者干脆通过文件浏览。 (痛苦的,如果你只是想找到一个变量应该如何使用) 我还没有找到一种方法来搜索Boost文档 - 谷歌搜索的网站:boost.org不会搜索助推文档 你如何搜索的官方Boost文档? 解决方案 什么是关于使用的这?
..
我目前正在开发一个C ++ - 为基于Python的模块。我发现的boost :: Python的状态相当好什么我要完成。不过,我现在运行到与正在通过的boost :: Python中产生的文档字符串一些问题。考虑下面的boost :: Python的定义: BOOST_PYTHON_MODULE(gcsmt) { class_< gcsmt ::单位和GT(“单位”,“设置为输入单位”
..
这令我很反感约升压的事情是他们的文档。我需要的是一个很好的参考,而是说明一个很好的参考就是我,我会给例如: java.sun.com/javase/6/docs/api/ 是的,我喜欢它。它也是这样的: CP preference.com /维基/ STL /矢量/启动 在另一方面我找到提升是这样的:
..
有一个工具,在那里类似的Javadoc 或的用于外壳脚本POD ? 谢谢 编辑:我不是在寻找现有的shell手册页 - 有很多的ksh / bash的code我们写/支,所以我一直在寻找沟通发生的事情的好办法,是否有潜力为code再利用等所有的东西的Javadoc是良好的。 解决方案 没有,但你可以尝试的滥用 doxygen的
..
(我已经看到了一些问题在这里对猛砸特殊的参数,它可能很难搜索* ,无论在Bash手动和通过像 $事谷歌这个问题的目的是对这些问题的一般参考。) 在Bash shell中定义了一些“特殊参数”(这本身是一个有点混乱,因为我们大多数人认为他们是“变量”,而不是“参数”)。引用它们由一个美元符号其次是一些标点符号的。 谷歌搜索包括标点字符的字符串是非常困难的,而且没有任何的出现,例如, $ 中的 B
..
是否有任何Backbone.js的好的文档?我想了解它,但阅读官方网页不方便对我来说,因为它没有结构良好。 例如阅读模式具有一定的解释,考虑到集合,后面描述。所以,如果有,描述在一个方便的家居为了理解一个结构良好的文档,请建议吧。 解决方案 我可以告诉你什么是我用来获取骨干的把握资源(我是后端开发人员转向前端的必要性在个人项目)。 本网站有很好的例子,从基础到高级,并且是pretty容
..
我终于找到了对象模型文档微软Office。 但它谈论互操作程序集和东西听起来像.NET。我不直接使用.NET,我真的不希望学到太多东西了。有没有一种方法,只是使用普通的COM / ActiveX类/接口自动化微软Word / Excel中? 解决方案 下面是一个KB文章,可以帮助您开始:的 http://support.microsoft.com/kb/216686/ ...而这一次:
..
我已经写了使用Java泽西(和JAXB)一pretty广泛的REST API。我也写使用维基的文件,但它是一个完全人工的过程,这是非常容易出错,尤其是当我们需要进行修改,人们往往忘记更新维基。 环视,其他大部分REST API的也手动创建自己的文档。但我不知道是否theres也许一个很好的解决了这一点。 那种事情需要记录每个端点分别是: 服务名称 类别 URI 参数 参数类型
..
我新的Eclipse和使用它我目前使用Java EE玩。 在使用Ctrl +空格键的类型/从常规的Java库中的函数,我得到的完整说明(即型号的一般描述,有哪些方法等的参数)。不过,我没有得到同样的Java EE的类型。 例如,在的HttpSession 类的方法,使用Ctrl +空格键时,我得到的只有名字,如“为arg0”或“目标文件”并没有说明。 是否有某种一揽子我可以安装到解决这个问题
..
在MSDN文档中,我们看到: 控制台 线程安全 此类型是线程安全的。 的TextWriter 线程安全 任何公共static 的(共享在Visual Basic中)的成员 这种类型是线程安全的。任何 实例成员都不能保证 线程安全的。 我已经开发了类似的(静态)类到控制台,所以我怎么可以标记它线程安全的?我提取XML文档,我也知道我可以这部分像在MSDN
..