Questions tagged «documentation»

因此，我正在尝试记录我正在编写的api返回的json格式，我想知道json结构的文档是否存在任何流行的格式。 请注意，我并不是要测试或验证任何东西，我只是使用它作为文档。还有一些向非常量添加注释的方法（总是返回带有相同值的项目）会很好。 这是我目前不完全考虑的方案： Plain names refer to identifiers or types. Some types have type-comment Strings that appear to be constant(always returned for that type of request) strings are "str" Constant Numbers would be just the number Constant null is null Booleans are true/false for constant booleans or Boolean otherwise [a,b,c] …

77 json  documentation  notation 

我正在尝试记录一种方法，并试图像JavaDoc中那样使用@link和。@code 我知道在Kotlin中有一个kDoc，但我找不到它们或至少找不到类似的东西。

77 documentation  kotlin  kdoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 5年前关闭。 改善这个问题 是否有网站或项目记录了iPhone SDK的专用API？

76 iphone  api  ios4  documentation  iphone-privateapi 

我正在尝试从我的模块中创建一个文档。我pydoc在Windows 7中使用Python 3.2.3从命令行使用： python "<path_to_pydoc_>\pydoc.py" -w myModule 这导致我的shell充满文本，模块中每个文件一行一行，说： no Python documentation found for '<file_name>' 就像Pydoc试图获取我的文件的文档一样，但是我想自动创建它。我找不到使用Google的优秀教程。有人对使用Pydoc有任何提示吗？ 如果我尝试使用以下方法从一个文件创建文档 python ... -w myModule\myFile.py 它说wrote myFile.html，当我打开它时，它有一行文字说： # ../myModule/myFile.py 另外，它具有指向我计算机上文件本身的链接，单击该链接即可显示Web浏览器中文件的内容。

76 python  documentation  python-3.x  documentation-generation  pydoc 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 3年前关闭。 改善这个问题 当我尝试导航到Android开发人员网站时，我被重定向到其中的大部分中文版本。例如，如果我尝试导航到： developer.android.com 我被重定向到： http://developer.android.com/intl/zh-cn/index.html 我想要英语网站。在某些情况下，我不得不将网页翻译成中文。我究竟做错了什么？如何抑制这种行为？

74 android  documentation 

我想知道是否有一种方法可以link在尝试使用编写新软件包的文档时从其他软件包运行roxygen2。像\link{pck=PACKAGE_NAME, fun=FUNCTION_NAME}什么？

73 r  documentation  roxygen2 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 2年前关闭。 改善这个问题 我将从一个例子开始。List.fill在Scala 2.10中，这相当于for元组作为宏： import scala.language.experimental.macros import scala.reflect.macros.Context object TupleExample { def fill[A](arity: Int)(a: A): Product = macro fill_impl[A] def fill_impl[A](c: Context)(arity: c.Expr[Int])(a: c.Expr[A]) = { import c.universe._ arity.tree match { case Literal(Constant(n: Int)) if n < 23 => c.Expr( Apply( Select(Ident("Tuple" + n.toString), "apply"), List.fill(n)(a.tree) ) ) …

72 scala  macros  documentation  scala-2.10  scala-macros 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 3年前关闭。 改善这个问题 我在哪里可以找到文件上运行的PDF中的JavaScript代码？ 我从未在PDF文档中添加JavaScript操作。但是，我已经使用JavaScript完成了很多Web开发。我对任何对PDF文档中的JavaScript熟悉的人有一些疑问。 NitroPDF和Adobe Acrobat绝对支持PDF文件中的JavaScript。是否存在关于存在的各种对象的标准，以及通过JavaScript处理PDF文件的功能？ 到目前为止，我发现的所有内容都来自Adobe。似乎还有其他地方可以参考Adobe的文档。是否有标准？或者Adobe仅是“事实”标准？ 另外，所有PDF查看器都支持JavaScript操作吗？ 我可以找到有关在PDF文档中使用JavaScript的最佳文档，该文档来自Adobe- Adobe :: Acrobat JavaScript脚本指南。 NitroPDF具有此链接-NitroPDF :: PDF文件中的JavaScript，但它基本上只是说它支持Adobe的功能。 我还从Scribus- Scribus ::如何使用JavaScript增强PDF表单中找到了此链接，但这仅包括一些小的代码片段。没有什么超级有用的。 Adobe拥有有关如何使用其IDE为JavaScript设置断点等的文档。是否可以使用另一个IDE在PDF文件中运行JavaScript并具有断点等？找到像Firebug一样酷的东西真是太棒了。 注意： 请不要回答如何操作Web浏览器中加载的PDF。问题是关于从PDF文档中运行JavaScript。我正在尝试通过执行PDF文档中的JavaScript来探索各种可能性。具体来说，我可能会使用quickpdflibrary中的函数将JavaScript功能添加到现有文档中。 另一个有用的链接是使用Acrobat JavaScript开发。显然，PDF中的JavaScript代码通常被称为AcroJS或Acrobat JavaScript。

72 javascript  pdf  documentation  acrobat  pdf-manipulation 

而已。如果要记录函数或类，请在定义之后放置一个字符串。例如： def foo(): """This function does nothing.""" pass 但是模块呢？如何记录file.py的功能？

72 python  documentation  python-module 

关闭。此问题不符合堆栈溢出准则。它当前不接受答案。 想改善这个问题吗？更新问题，使其成为Stack Overflow的主题。 3年前关闭。 改善这个问题 Linux中是否存在C ++文档？我想要类似C的手册页的内容。例如，有关string，stl，iostream，ifstream等的文档？

72 c++  linux  documentation  manpage 

编辑：从技术上讲这是一个两部分的问题。我选择了涵盖一般问题并与处理特定问题的答案相关联的最佳答案。 用jsdoc记录匿名对象和函数的最佳方法是什么？ /** * @class {Page} Page Class specification */ var Page = function() { /** * Get a page from the server * @param {PageRequest} pageRequest Info on the page you want to request * @param {function} callback Function executed when page is retrieved */ this.getPage = function(pageRequest, callback) …

71 javascript  documentation  tags  jsdoc 

已关闭。这个问题是基于观点的。它当前不接受答案。 想改善这个问题吗？更新问题，以便通过编辑此帖子以事实和引用的形式回答。 3年前关闭。 改善这个问题 我正在为新的内部Web服务编写RESTful API规范。它不是很长，也不是很简单，但是即使如此，这也是我第一次使用严格的REST（而不是出于实际原因作弊-避免这样做，PUT并且DELETE因为它们在PHP中很痛苦，依此类推）。我想知道是否有任何标准方法或最佳实践来记录REST接口？我希望团队中的其他成员能够一目了然地理解它，对于希望编写客户端的任何人，也可以在不了解底层代码的情况下做到这一点。

70 rest  documentation 

已关闭。这个问题需要更加集中。它当前不接受答案。 想改善这个问题吗？更新问题，使其仅通过编辑此帖子来关注一个问题。 3年前关闭。 改善这个问题 Mogenerator的帮助非常小。所有参数都做什么？

68 documentation  mogenerator