代码之家  ›  专栏  ›  技术社区  ›  dkretz

参考级文件稀缺?[关闭]

  •  1
  • dkretz  · 技术社区  · 17 年前

    我的工作往往涉及使用其他地方的工具和库,而不是提供这些东西供外部消费。但对于我们内部所做的工作,“文档”意味着提供简洁地列举了其他人使用的功能的信息。按照习惯,我们倾向于生成看起来像UNIX手册页的东西,但我不会说我们认为这是最终的格式。

    我认为这些东西将是第一个也是最容易生产的材料,因为它对于受控的开发和发布过程来说是强制性的。

    2 回复  |  直到 17 年前
        1
  •  1
  •   ChrisLively    17 年前

    例如,看看查找日期时间字符串格式字符需要多长时间。

        2
  •  0
  •   Bill Karwin    17 年前

    不同类型的文档适用于不同的用途(也是必要的)。

    • 视频

    • 很好。但这些并没有向你展示异国情调的案例或最佳实践;他们只展示了使用该技术的一种场景。

    • 任务导向

    • 当你基本上熟悉这项技术,但你只需要一个方法签名等的参考时,那么 API文件 是合适的。这些可以集成到IDE中。

    推荐文章