月度归档:2018年07月

参考文献与注释的区别与关系

参考文献是作者撰写论著时所引用的已公开发表的文献书目,集中列表于文末;注释主要包括释义性注释引文注释,一般印刷在该页的脚1或集中列于文末参考文献表之前2。释义性注释是对论著正文中某一特定内容的进一步解释或补充说明;引文注释包括各种不宜引入文后参考文献的引文和个别文后参考文献的节略形式,如:

  • 未公开发表的私人通信
  • 档案资料
  • 内部资料
  • 书稿
  • 古籍(1911 年以前出版、无现代版本的各种版本)
  • 仅有中介文献信息的『转引自』类文献
  • 待发表文献
  • 未公开发表的会议文献
  • 文后参考文献的节略形式

参考文献

  • [1] 中国学术期刊(光盘版)编辑委员会. 中国学术期刊(光盘版)检索与评价数据规范[S]. CAJ-CD B/T 1-2006, 2006: 10–11.

  1. 通常是释义性注释 ↩︎
  2. 通常是引文注释 ↩︎

【编写可维护的 JavaScript】读书笔记

编写可维护的 JavaScript(Maintainable JavaScript)

编写可维护的 JavaScript

添加注释的一般原则是,在需要让代码变得更清晰时添加注释:

  • 难以理解的代码
  • 可能被误认为错误的代码
  • 浏览器特性 hack

事件处理的实践规则:

  • 规则 1:隔离应用逻辑
  • 规则 2:不要分发事件对象

规则 1 把应用逻辑和时间处理代码中拆分开来,这样应用逻辑可被不同事件或非事件重用,测试时也能直接触发而不必通过模拟事件来触发。

规则 2 是指事件处理器中处理 event 对象,然后把需要的数据传给应用逻辑,而不是把 event 对象传送下去,应用逻辑依赖具体的数据而不是事件对象。

事件处理程序应当在进入应用逻辑之前针对 event 对象执行任何必要的操作,包括组织默认事件和阻止事件冒泡,都应当直接包含在事件处理程序中。

如果所有的失败(错误)都是悄无声息的,首要的问题是那必将消耗你大量的时间才能发现它,更不要说单独隔离并修复它了。

我们的目的不是防止错误,而是在错误发生时能更加容易地调试。(阅注:在处理接口数据时,有的时候需要编写防御性代码来让业务继续工作而不是直接跑错误终止逻辑。)

继续阅读

import 与 require 的两个差异

Javascript 的模块化开发,除了 RequireJS 代表的 AMD 外,目前广泛使用的是 Node.js 代表的 CommonJS 以及 ES6 的 module。

在 babel / webpack 等工具链下,大多数情况下,CommonJS 的 require 和 ES6 的 import 效果等同,babel 的 preset 是 ES2015 以及 webpack 都是把 import 转为 require(webpack 根据 target 再转为 AMD 或 UMP 等格式)。

但两个规范实质上并不等同,所以存在着不少的区别,如不能 import(var) 但能 require(var),详细可查看 ES6 模块系统,此处记录一下两个可能比较直接影响代码书写的差异点。

继续阅读

git pull 与 rebase

最初使用独立的工具 git-up,后来 git 支持了同样的功能,通过配置 git config --global alias.up 'pull --rebase --autostash 即可达到同样的效果。

如果希望在 pull 的时候直接使用 rebase 机制,可以像下面这样配置

git config --global pull.rebase true
git config --global rebase.autoStash true

git pull 效果

git pull 效果

git pull —rebase 效果

git pull --rebase 效果

【数据之美】读书笔记

数据之美:一本书学会可视化设计(Data Points: Visualization That Means Something)

数据之美:一本书学会可视化设计

笔记摘要

引言 可视化是一种媒介

由于数据代表了一定的人物、地点和事物,所以除了真实的数字之外,还有重要的背景信息。数据是关于谁的?它从哪里来以及是什么时候收集的?虽然是计算机生成并输出数据,但我们也需要对这些由人处理的部分负责。

花一些时间去了解数据以及它们所代表的东西,能加倍提升可视化的效果。

无论哪一种可视化类型都有其规则可循。这些规则并不取决于设计或统计数字,而受人类感知的支配。它们确保读者能准确解读编码数据。

规则是应该时时遵循的,而建议则要具体分析,视情况而决定是否采纳。

继续阅读