博客站长要养成阅读 ReadMe 的好习惯

2019-01-0211:13:41 4 376
摘要

其实,阅读ReadMe文档并不一定就可以熟练的使用了,但是可以通过阅读ReadMe文档了解这个代码或者插件、脚本的开发思路、功能特性、运行原理,什么事儿了解了原理使用上手其实也就不是个事儿了都。有人会说有时候根本就找不到ReadMe文档怎么办呢?答案很简单,明月将这类代码、插件、脚本归类为“来历不明”,请慎重考虑选择和使用。

不知道从什么时候开始,明月发现很多的站长们在使用插件、代码、扩展、应用的时候完全忽略了 ReadMe 的阅读必要性,基本上都是出了问题就到处张嘴就问,评论里、QQ 里、Telegram 群组里这样的人几乎每天都可以看到,问的问题其实结果大部分都已经在 ReadMe 文档里了可就是没有人想到去看看这个 ReadMe 文档,不得不说,这种奇葩的思维模式让明月很是反感。

今天,明月就给大家讲讲阅读  ReadMe 好习惯养成的重要性。下面先给大家脑补一下什么是 ReadMe ?

何为 ReadMe?

读我档案(英文:Readme),又称“自述文件”,是随着软件发布的一种说明文件,里面通常包含有软件的描述或使用的注意事项。这种档案通常是纯文字文件,被命名为 README.TXT、README.1ST 或 READ.ME 等等,但也有 RTF、DOC 或 Markdown 格式的读我档案。档名通常是以大写英文字母组成,这是因为大写字母比小写字母有着较小的 ASCII 码,因此在一些以 ASCII 顺序来排序档案名称的操作系统里,它会被列在档案列表的第一个。即使这些人没有关于读我档案的知识,这种档案的特殊命名方式也能够使任何人迅速发现。

摘录自『维基百科』

经常使用或者浏览 GitHub 的站长们如果细心一点就会发现 GitHub 上的项目都默认会有一个 README.md 文件,并且访问 GitHub 项目链接的时候首页几乎都是清一色的显示 README.md 文档。这就很能说明 ReadMe 文档的重要意义了,毕竟 GitHub 作为全球第一的源代码托管服务网站,汇集的都是全球的开发编程人员,既然 GitHub 这么强调和重视 ReadMe 文档可想而知这个 ReadMe 文档其实就是代码的灵魂描述,毕竟不是所有人都可以对源代码像自然语言那样进行阅读和理解的。所以我们也可以理解为 ReadMe 文档其实就是代码或者插件、脚本等等的说明文档,也可以理解为是一种“使用说明”也不为过。

对于我们站长来说无论是插件代码、主题代码、脚本代码等等,在 ReadMe 文档里都会有基本使用、安装说明以及常见问题汇总的,代码编写者既然分享出来了当然是为了让大家使用的,自然会在 ReadMe 文档认真的总结和书写必要的信息给使用者的,所以 ReadMe 文档有时候就是“官方使用说明”的另一种存在形式。

所以,明月强烈建议大家在获取到一个插件、主题、代码、脚本等等别人开发的东西的时候要找找里面的 ReadMe 文档或者类似的 TXT 文件等等阅读一下,有中文的当然最好了,没有中文的现在的在线翻译能力已经非常的逆天了,在其帮助之下基本的意思和思路还是可以理解,当然如果你的语文是体育老师教的除外!

在阅读了相关的 ReadMe 文档后还是搞不定的时候,你再去提问和网上搜索查询时就会发现你的提问就会更加的精准了,找到答案和解决办法的速度也就快了很多,否则一无所知的情况下的问题只能突显你的“弱智”和“小白特质”而已。

其实,阅读 ReadMe 文档并不一定就可以熟练的使用了,但是可以通过阅读 ReadMe 文档了解这个代码或者插件、脚本的开发思路、功能特性、运行原理,什么事儿了解了原理使用上手其实也就不是个事儿了都。有人会说有时候根本就找不到 ReadMe 文档怎么办呢?答案很简单,明月将这类代码、插件、脚本归类为“来历不明”,请慎重考虑选择和使用。


现在真的是太冷了,打字儿更新文章是个很辛苦的活儿,文章最后明月来一波广告:

历史文章推荐:

  • 打赏明月一下下
  • 多谢您的赞赏!
  • weinxin
  • 本博客小程序
  • 微信内浏览本博客
  • weinxin

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

目前评论:4   其中:访客  2   博主  2

    • MAY 3

      谢谢明月大佬的指点~~~

      • 记录生活 1

        :???: 因为我的无知,好尴尬啊