RError.com

RError.com Logo RError.com Logo

RError.com Navigation

  • 主页

Mobile menu

Close
  • 主页
  • 系统&网络
    • 热门问题
    • 最新问题
    • 标签
  • Ubuntu
    • 热门问题
    • 最新问题
    • 标签
  • 帮助
主页 / 问题 / 849386
Accepted
wcobalt
wcobalt
Asked:2020-07-03 02:33:40 +0000 UTC2020-07-03 02:33:40 +0000 UTC 2020-07-03 02:33:40 +0000 UTC

文档是为谁编写的?

  • 772

假设一个团队开发的不是一个可以获取和使用的程序,而是一个供其他程序员使用的库。那么:代码文档是为将要使用该库的人还是为开发它的团队编写的?

документация
  • 3 3 个回答
  • 10 Views

3 个回答

  • Voted
  1. Best Answer
    avp
    2020-07-03T04:57:06Z2020-07-03T04:57:06Z

    对于那些将使用您的产品的人,有关其使用、安装等的文档。绝对需要。否则,没有人(可能除了少数书呆子)会尝试您的创作。

    内部文档(包括描述构建过程)是非常可取的,但通常没有足够的时间来做,整个团队都以自我记录代码为借口。

    • 2
  2. pepsicoca1
    2020-07-03T19:33:02Z2020-07-03T19:33:02Z

    关于软件文档有一个明智的 GOST 19.***。这个 GOST 说明了它应该是什么文件以及它应该是什么形式。

    简而言之:

    1. 对于用户来说,写的是应用程序的描述——即程序和/或库的接口(即调用列表)的描述。

    2. 对于开发人员,编写程序的描述 - 这是对程序内部结构的描述,考虑到编写程序的语言中的文本。

    • 2
  3. Dmitry Kalinin
    2020-07-03T02:48:03Z2020-07-03T02:48:03Z

    通常编写文档是为了便于理解库(函数或类方法)作为输入接收的内容以及作为输出返回的内容。如果库是公共的,那么它是为每个人编写的,如果它是私有的,那么它是为团队编写的。

    • 1

相关问题

Sidebar

Stats

  • 问题 10021
  • Answers 30001
  • 最佳答案 8000
  • 用户 6900
  • 常问
  • 回答
  • Marko Smith

    是否可以在 C++ 中继承类 <---> 结构?

    • 2 个回答
  • Marko Smith

    这种神经网络架构适合文本分类吗?

    • 1 个回答
  • Marko Smith

    为什么分配的工作方式不同?

    • 3 个回答
  • Marko Smith

    控制台中的光标坐标

    • 1 个回答
  • Marko Smith

    如何在 C++ 中删除类的实例?

    • 4 个回答
  • Marko Smith

    点是否属于线段的问题

    • 2 个回答
  • Marko Smith

    json结构错误

    • 1 个回答
  • Marko Smith

    ServiceWorker 中的“获取”事件

    • 1 个回答
  • Marko Smith

    c ++控制台应用程序exe文件[重复]

    • 1 个回答
  • Marko Smith

    按多列从sql表中选择

    • 1 个回答
  • Martin Hope
    Alexandr_TT 圣诞树动画 2020-12-23 00:38:08 +0000 UTC
  • Martin Hope
    Suvitruf - Andrei Apanasik 什么是空? 2020-08-21 01:48:09 +0000 UTC
  • Martin Hope
    Air 究竟是什么标识了网站访问者? 2020-11-03 15:49:20 +0000 UTC
  • Martin Hope
    Qwertiy 号码显示 9223372036854775807 2020-07-11 18:16:49 +0000 UTC
  • Martin Hope
    user216109 如何为黑客设下陷阱,或充分击退攻击? 2020-05-10 02:22:52 +0000 UTC
  • Martin Hope
    Qwertiy 并变成3个无穷大 2020-11-06 07:15:57 +0000 UTC
  • Martin Hope
    koks_rs 什么是样板代码? 2020-10-27 15:43:19 +0000 UTC
  • Martin Hope
    Sirop4ik 向 git 提交发布的正确方法是什么? 2020-10-05 00:02:00 +0000 UTC
  • Martin Hope
    faoxis 为什么在这么多示例中函数都称为 foo? 2020-08-15 04:42:49 +0000 UTC
  • Martin Hope
    Pavel Mayorov 如何从事件或回调函数中返回值?或者至少等他们完成。 2020-08-11 16:49:28 +0000 UTC

热门标签

javascript python java php c# c++ html android jquery mysql

Explore

  • 主页
  • 问题
    • 热门问题
    • 最新问题
  • 标签
  • 帮助

Footer

RError.com

关于我们

  • 关于我们
  • 联系我们

Legal Stuff

  • Privacy Policy

帮助

© 2023 RError.com All Rights Reserve   沪ICP备12040472号-5