码农胖虎-java 2015-09-13 11:32 采纳率: 100%
浏览 1473
已采纳

大家怎么看待编程开发文档

才学习文档的书写，感觉好长，好麻烦~不知道经验丰富的大牛们是怎么看待开发文档这个东西的？

  • 写回答

7条回答 默认 最新

  • threenewbee 2015-09-13 11:43
    关注

    文档的几个基本原则
    （1）说明你要做什么，怎么做是代码说明的事情
    （2）接口要有详细的文档
    （3）不要把不需要的东西写在文档中，写的越多，有用的东西被看到的概率越低

    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论
查看更多回答(6条)

报告相同问题？

悬赏问题

  • ¥15 #MATLAB仿真#车辆换道路径规划
  • ¥15 java 操作 elasticsearch 8.1 实现 索引的重建
  • ¥15 数据可视化Python
  • ¥15 要给毕业设计添加扫码登录的功能！！有偿
  • ¥15 kafka 分区副本增加会导致消息丢失或者不可用吗？
  • ¥15 微信公众号自制会员卡没有收款渠道啊
  • ¥100 Jenkins自动化部署—悬赏100元
  • ¥15 关于#python#的问题：求帮写python代码
  • ¥20 MATLAB画图图形出现上下震荡的线条
  • ¥15 关于#windows#的问题：怎么用WIN 11系统的电脑 克隆WIN NT3.51-4.0系统的硬盘