PerfectPan
;

文档书写要点整理

March 01, 2020

前言

最近在兼职 leetcode 的写题解职务,然而今天交上去以后,被别的审稿人挑了非常多的错误= =,查了一下审稿的是个 THU 的大佬(星星眼),所以记录一下,以后写完题解都 check 一下,努力完善自己写的文档。

通用部分

阅读中文文案排版指北

markdown 中段落与段落间要空行保持美观

减少口语化表达,注意断句

所有较复杂的公式(例如较长、带上下标)独占一行

Latex部分

Latex 环境中如果出现长名字的变量,用 \textit{} 包裹会更美观

对于 log 需要用 \log 来表达

行间代码不要使用 Latex 环境

右箭头用 \rightarrow 来代替 ->

题解部分

尽量不要出现一些语言特定的保留字,比如 NULL\textit{NULL} ,要考虑到受众 可能不会你这种语言,一般来说需要用口头语言表达这种情况即可

规范代码格式

时间复杂度分析:在不分析平均时间复杂度的前提下,不需要分析最优的时间复杂度

空间复杂度分析:只计算额外空间复杂度,存储答案的空间不需要计入


Yiming Pan

Written by Yiming Pan who lives and works in Hangzhou China. Welcome follow me on Github

Cannot load comments. Please check you network.