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

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

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

  • 写回答

7条回答 默认 最新

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

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

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

报告相同问题?

悬赏问题

  • ¥30 vmware exsi重置后登不上
  • ¥15 易盾点选的cb参数怎么解啊
  • ¥15 MATLAB运行显示错误,如何解决?
  • ¥15 c++头文件不能识别CDialog
  • ¥15 Excel发现不可读取的内容
  • ¥15 关于#stm32#的问题:CANOpen的PDO同步传输问题
  • ¥20 yolov5自定义Prune报错,如何解决?
  • ¥15 电磁场的matlab仿真
  • ¥15 mars2d在vue3中的引入问题
  • ¥50 h5唤醒支付宝并跳转至向小荷包转账界面