JavaScript学习:从Prototype想到用户说明

  晚上终于看到了大名鼎鼎的progotype.js的全貌,第一次看到,有点晕头转向。

  大概就像作者所说的,他们并不擅长于写用户文档,所以用起来应该确实会很吃力。正像作者自己所困惑的那样,希望能够有人来写用户文档。

  Prototype needs your documentation
  If you’ve written tutorials for, shared examples of, or otherwise documented any part of Prototype, we’d like to include your work in our upcoming official documentation site. We’re also looking for a few people to help maintain the documentation when it’s up.

  一套好的代码当然应该具备好的说明文档,否则代码的可读性会成为困扰用户使用的严重问题。一个Coder不仅应该在Coding时很优秀,在Documenting方面同样要有相当的经验。即使接口的实现十分冗繁,但是只要质量和效率能够保证,it’s okay,问题不是很严重。就像写CSS时,按照w3c规范实在没有办法满足某些兼容性了,那就用hack啊,没问题,没有人会怪你,怪就怪浏览器去。只要你能够教会用户如何使用这些接口就可以了。

  “每一个整洁的接口背后都有一个龌龊的实现。”只要接口整洁到足够让用户很容易的进行使用即可。

  可以在这里下载到prototype.js的五月一日发布的新版本。

Leave a Reply

Be the First to Comment!

avatar