V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
cheneydog
V2EX  ›  问与答

弱类型语言的 API 文档,这种情况怎么写?

  •  
  •   cheneydog · 2016-04-28 16:25:27 +08:00 · 1867 次点击
    这是一个创建于 3165 天前的主题,其中的信息可能已经有所发展或是发生改变。
    因为通常用中括号表示某个参数是可选的:

    ```
    bus.error([eventname],callback)
    ```

    但是又想用用括号表示参数应该是数组的。


    ```
    bus.line([e1,e2,[e3,...]])

    ```

    于是导致混淆,这种情况通常是怎么区分的?
    4 条回复    2016-04-29 10:17:58 +08:00
    tabris17
        1
    tabris17  
       2016-04-28 16:30:38 +08:00
    InkStone
        2
    InkStone  
       2016-04-28 16:30:53 +08:00
    参数是数组你就在下面的参数详解当中注明呀

    或者你想表达的意思是可变参数列表? 那就是 foobar(arg1, arg2, arg3...) 或者干脆 foobar(*args)
    msg7086
        3
    msg7086  
       2016-04-28 20:53:24 +08:00
    别用中括号表示可选呗。
    别的语言里一般是用默认值来表示可选项的,比如
    bus.error(eventname = 'Nothing', callback)
    这种。
    heliumhgy
        4
    heliumhgy  
       2016-04-29 10:17:58 +08:00 via Android
    这叫动态类型吧
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2505 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 01:33 · PVG 09:33 · LAX 17:33 · JFK 20:33
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.