标签: documentation

当我尝试导航到Android开发者网站时,我被重定向到它的一个版本,其中大部分都是中文版.例如,如果我尝试导航到:

developer.android.com

我被重定向到:

http://developer.android.com/intl/zh-cn/index.html

我想要英语网站.在某些情况下,我必须从中文翻译网页.我究竟做错了什么？我怎么能抑制这种行为？

我是Pandas的新手,我正在尝试使用date_range.我碰到各种各样的好东西来的freq,就像BME和BMS我希望能够快速查找正确的字符串来获得我想要的东西.昨天我在文档的某个地方找到了一个格式很好的表格,但是表格的标题太过于迟钝,以至于我今天无法使用搜索找到它.

我将从一个例子开始.这里的List.fill元组与Scala 2.10中的宏相当:

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)
        )
      )
      case _ => c.abort(
        c.enclosingPosition,
        "Desired arity must be a compile-time constant less than 23!"
      )
    }
  }
}

我们可以使用以下方法:

scala> TupleExample.fill(3)("hello")
res0: (String, String, String) = (hello,hello,hello)

这个家伙在几个方面都是一只奇怪的鸟.首先,arity参数必须是一个文字整数,因为我们需要在编译时使用它.在Scala的早期版本中,(根据我所知),方法甚至无法判断其中一个参数是否是编译时文字.

其次, …

假设,作为记录代码(Javadoc)的一部分,您希望使用深度缩进来指示元素之间的关系.

如何创建嵌套列表:

• 一些元素
  • 其他一些因素
    • 还有一些其他因素

我有一些代码返回一个promise对象,例如使用Node库的Q库.

var Q = require('q');

/**
 * @returns ???
 */
function task(err) {
    return err? Q.reject(new Error('Some error')) : Q.resolve('Some result');
}

如何使用JSDoc记录这样的返回值？

在哪里可以找到有关在PDF中运行Javascript的文档？

我从未在pdf中添加javascript动作.但是,我已经使用javascript做了很多web开发.对于熟悉PDF中的javascript的人,我有几个问题.

NitroPDF和Adobe Acrobat肯定支持PDF格式的javascript. 是否有存在的各种对象的标准和通过javascript操作pdf的功能？ 到目前为止我发现的一切都来自Adobe.其他任何地方似乎都参考了Adobe的文档.那里有标准,还是Adobe只是"de Facto"标准？

此外,所有PDF查看器都支持JavaScript操作吗？

在我可以找到的pdf文档中使用javascript的最佳文档来自Adobe - Adobe :: Acrobat Javascript脚本指南.

NitroPDF有这个链接 - 在PDF文件中的NitroPDF :: Javascript,但它基本上只是说它支持Adobe所拥有的.

我还从Scribus发现了这个链接 - Scribus ::如何使用JavaScript增强PDF表单,但这只包括一小段代码.没有什么超级有用的.

Adobe有关于如何使用IDE为javascript设置断点等的文档.是否可以使用另一个IDE在pdf中运行javascript并有断点等...？找到像Firebug一样酷的东西真是太棒了.

注意:

请不要回答如何操作Web浏览器中加载的PDF.问题是关于从PDF文档中运行javascript.我正试图通过在PDF文档中执行javascript来探索可用的可能性.具体来说,我可以使用quickpdflibrary中的函数将javascript功能添加到现有文档中.

编辑

另一个有用的链接是使用Acrobat Javascript进行开发.显然,PDF格式的js经常被称为AcroJS或Acrobat JavaScript.

我刚从CACM的一篇文章中了解到,Doxygen也使用Java(以及其他几种语言).但是Java已经有了Javadoc工具.有人可以解释这两种方法的优缺点是什么？它们是互相排斥的吗？是否有Doxygen的Maven插件？

我正在为新的内部Web服务编写RESTful API规范.这不是很长很简单,但即便如此,这是我第一次使用严格的REST(而不是出于实际原因作弊 - 避免PUT,DELETE因为它们是PHP的痛苦,等等).我想知道是否有任何标准方法或最佳实践来记录REST接口？我希望团队的其他成员能够一目了然地理解它,对于任何想要编写客户端的人来说,如果不了解底层代码就能够这样做.

所以我试图记录我正在写的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] are lists with 3 items a,b,c
[...  ...] is a list of repeating elements of some types/constants/patterns
{a:A,b:B,c:c} and {... ...}  is the same for a dictionary.

例:

story          := …

而已.如果要记录函数或类,请在定义之后放置一个字符串.例如:

def foo():
    """This function does nothing."""
    pass

但是模块怎么样？如何记录file.py的作用？