专栏首页程序员互动联盟读不懂英文文档,能写出代码不?

读不懂英文文档,能写出代码不?

作为一个开发人员,开发一个新项目,维护一个项目,想要快速的开展工作。最重要的是干什么?是阅读项目文档,没文档看代码。可见我们首要做的事情是看文档看懂文档,编程初学其实也是看文档,这个文档是基础知识的书籍。所以是相同的。

好的项目或者软件都是文档十分完善的,虽然说专看文档不看源码对项目软件学习没什么卵用。但是文档在手如有神助,就如君子爱财取之有道矣。

看文档如读书,读书是有思考的记忆,每个人读书的方式都不一样,造成理解和深入情况不尽相同。如何更高效的来阅读文档是一个初学这首要解决的方法问题,方法用对事办功倍。

特别是一些开源的项目,咋天朝的开发都是人家一开源咱就自主研发成功,你懂的,既然是外国人开发的,那文档啥的肯定是英文的,所以这个文档特别是英文文档有多么重要。一个问题搜了一圈,中文的都不太靠谱没有指出问题的关键点,翻译的是千差万别。不硬着头皮看懂英文文档,特别是代码里的关键说明。你分析问题走的路就会拐十八道弯的。

做好以下三点来用文档来提高你对项目和代码的理解

一、泛读一遍

文档到手先是仔细看些文档的用途,提纲目录是否是自己需要的。本身你想要一个讲架构的文档,而你却看的一个api说明文档。泛读就是看是否是自己的需求,能从中获取一些概念,文档讲了一些什么内容。

二、精读一遍

确定文档可用性后就是深入阅读,我就不再满足于书上的例子了,我会自己发散思维,试着举一反三,自己举例子来应用这些代码。也会去看看书上提出的练习,然后试着靠自己去解决这些问题。每一章节的语法都熟记于心。

三、操作一遍

看书或看文档,里面一般都会有具体的思路,这有助于我们的理解。除了书中的练习题和文档中demo,比如你安装QT SDK的时候就有文档和demo,基本上就可以用demo尝试着做做自己的项目。另外,请一定要自己亲手写代码,不要想当然地以为阅读和理解代码就够了好记性不如多敲敲键盘。

总结就是这三板斧,但真正能坚持实施才是关键,往往我们在实现出现偏差,对于一个初学者首要的任务是看懂文档,然后在去熟悉代码,但是也会有那只一个项目出来代码就没啥的情况,这个就得需要发挥个人智慧,跟老员工套近乎。拜个师傅,端个茶递个水,多请教。

本文分享自微信公众号 - 程序员互动联盟(coder_online)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2015-12-26

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 【答疑释惑】C++异常处理是咋回事?

    疑惑一 C++的异常处理 一、什么是异常处理 一句话:异常处理就是处理程序中的错误。 二、为什么需要异常处理,以及异常处理的基本思想 C++ 之父Bjarne ...

    程序员互动联盟
  • 【入门必备】常用的C语言编程工具

    中国有句古话叫做“工欲善其事,必先利其器”,可见我们对工具的利用是从祖辈就传下来的,而且也告诉我们在开始做事之前先要把工具准备好。有了好的工具那么我们做起事来也...

    程序员互动联盟
  • 码农的烦恼

    摘要:对于码农来说,永远没有完美与满意:怎样完美的代码,都跟不上技术更新的节奏;怎样的尽心尽力,都满足不了客户的要求。想仰天长啸,抬抬头才发现还在“小黑屋”里与...

    程序员互动联盟
  • DevOps 下的文档及其版本管理设计

    在传统的软件交付过程中,开发、测试、运维多数情况下是分开进行的,开发行为和运维行为之间存在严重的脱节现象,而且敏捷开发人员希望能够快速进行软件的部署,以实现快速...

    DevOps时代
  • 谷歌软件工程师是怎样写设计文档的?

    谷歌软件工程文化的主要元素之一就是通过设计文档定义软件设计。在开始项目编码工作之前,软件系统或应用程序的作者会创建这些相对非正式的文档。设计文档记录了高级实现策...

    深度学习与Python
  • DAS 2020 Keynote Speech | Adobe 文档分析技术介绍

    DAS 2020 (Document Analysis System,文档分析系统研讨会) 于 7月26-29日在武汉召开,本次研讨会中有不少精彩的内容,昨天向...

    CV君
  • GO 文档笔记

    最开始写 GO 的时候, 发现方法的注释并不支持@param, @return等参数, 搞得我都不知道该如何给自己的方法写文档说明了. 而且网上搜了搜也没有搜到...

    烟草的香味
  • 细说RESTful API之文档管理

    规范的接口文档管理方式有助于提高组件协同(如:前后端分离)的开发效率,对于项目的接口说明有全局的管理视角,甚至可以方便地实现对外发布。 完善的文档管理应该包含...

    2Simple
  • Elasticsearch学习-父子文档

    上一篇文章介绍了Elasticsearch的嵌套文档,这一篇来介绍另外一种关系文档,父子文档。

    dalaoyang
  • Mac端都有哪些不错的编程文档查询工具

    在编程过程中,我们经常会遇到这样的情况,查一些语言的api,大多情况都是直接去官网查询。但总会遇到这样几种情况:

    A梦多啦A

扫码关注云+社区

领取腾讯云代金券