← 返回笔记

让笔记更易读

为文字、代码和公式留出合适的位置,也给下一次回看留下线索。

从问题开始

一份值得回看的笔记,可以先写清楚:要回答什么问题,已知条件是什么,以及目前还缺少哪些证据。标题尽量具体,长内容则用小节组织。

留下可以重现的步骤

代码尽量保留输入、运行方式和必要的输出。使用带语言标记的代码块,阅读时就能更容易分辨结构。

def squared_energy(x):
    """A small example for checking calculations."""
    return 0.5 * sum(value ** 2 for value in x)

print(squared_energy([1, 2, 3]))  # 7.0

公式与符号

先定义符号,再写公式。例如,向量 x=(x1,,xn)x=(x_1,\ldots,x_n) 的一个简单二次函数可以写为:

E(x)=12i=1nxi2.E(x)=\frac{1}{2}\sum_{i=1}^{n}x_i^2.

将代码和对应表达式放在一起,也方便检查它们是否一致。

给未来的自己留一条线索

  • 补充原始来源和访问链接。
  • 记录会影响结果的版本、参数与假设。
  • 明确哪些是观察,哪些仍然只是猜想。
  • 修改结论时,也更新文中的适用条件。

笔记不必一次写完,但应当让下一次继续变得容易。

感谢读到这里。
← 全部笔记RSS 订阅