Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
julycoding authored Nov 26, 2017
1 parent a5291a4 commit 0cc4536
Showing 1 changed file with 39 additions and 20 deletions.
59 changes: 39 additions & 20 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,39 +35,45 @@

## Code Style
本项目暂约定以下代码风格(不断逐条添加中):
- 关于空格
关于空格
- 所有代码使用4个空格缩进
- 运算符后使用一个空格
- "," 和for循环语句中的";" 后面跟上一个空格
- 条件、分支保留字,如 if for while else switch 后留出一个空格
- "[]", "."和"->" 前后不留空格
- 用空行把大块代码分成逻辑上的“段落
- 关于括号

关于括号
- 大括号另起一行
- 即便只有一行代码也加大括号
- C 指针中的指针符靠近类型名,如写成int* p,而不写成int *p
- 关于标点

关于标点
- 中文表述,使用中文全角的标点符号,如:()、。,?
- 数学公式(包括文中混排的公式)和英文代码,使用英文半角的标点符号,如:(),.?…
- 关于注释

关于注释
- 注释统一用中文
- 尽量统一用"//",一般不用"/\*...\*/"
- 关于命名

关于命名
- 类名为大写字母开头的单词组合
- 函数名比较长,由多个单词组成的,每个单词的首字母大写,如int MaxSubArray();函数名很短,由一个单词组成,首字母小写,比如int swap()
- 变量名比较长,由多个单词组成的,首个单词的首字母小写,后面紧跟单词的首字母大写,如maxEnd;变量名很短,由一个单词组成,首字母小写,如left
- 变量尽量使用全名,能够描述所要实现的功能,如 highestTemprature;对于已经公认了的写法才使用缩写,如 tmp mid prev next
- 变量名能“望文生义”,如v1, v2不如area, height
- 常量的命名都是大写字母的单词,之间用下划线隔开,比如MY_CONSTANT
- il < 4384 和 inputLength < MAX_INPUT_LENGTH,后一种写法更好

- 一个函数只专注做一件事
- 时间复杂度小写表示,如O(nlogn),而不写成O(N*logN)
- 正文中绝大部分采用C实现,少量C++代码,即以C为主,但不去刻意排斥回避C++;
- 关于的地得

关于的地得
- 形容词(代词) + 的 + 名词,例如:我的小苹果
- 副词 + 地 + 动词,例如:慢慢地走
- 动词 + 得 + 副词,例如:走得很快
- 关于参考文献
关于参考文献
- 格式:主要责任者.书名〔文献类型标识 ] .其他责任者.版本.出版地:出版者,出版年.文献数量.丛编项.附注项.文献标准编号。例子:1 刘少奇.论共产党员的修养.修订 2 版.北京:人民出版社,1962.76 页.
- 专业术语
- 统一一律用“树结点”,而不是“树节点”。
Expand Down Expand Up @@ -100,45 +106,58 @@
- 第四周,继续在Word 上做出最后彻底的改进,若未发现bug或pull request,本github将暂不再改动;
- 6月30日,与出版社约定的交稿日期延期,理由:目前版本不是所能做到的最好的版本。
- 2014年7月,邀请部分好友进行第一轮审稿,包括曹鹏、邹伟、林奔、王婷、何欢,其中,曹鹏重写优化了部分代码。此外,葛立娜对书稿中的语言描述做了不少改进;
- 2014年8月

2014年8月
- 8月上旬,新增KMP一节内容;
- 8月下旬,重点修改SVM一节内容;
- 2014年9月

2014年9月
- 9月上旬,和一些朋友一起重绘稿件中的部分图和公式,这部分朋友包括顾运(@陈笙)、mastermay、在山东大学读研二的丰俊丙、厦门大学电子工程系陈友和等等;
- 9月下旬,再度邀请另一部分好友进行第二轮审稿,包括许利杰、王亮、陈赢、李祥老师、litaoye等,并在微博上公开征集部分读者审稿,包括李元超、刘琪等等;
- 2014年10月

2014年10月
- 10月8日起,开始一章一章陆续交Word 稿给出版社初审
- 10月9日,第一章、字符串完成修改;
- 10月10日,第二章、数组完成修改;
- 10月22日,第三章、树完成修改;
- 2014年11月

2014年11月
- 11月5日,第三章、树完成第二版修改,主要修正部分图片、公式、语言描述的错误;
- 2014年12月

2014年12月
- 12月1日,第四章、查找完成修改。至此,前4 章的修改稿交付出版社。
- 12月8日,第五章、动态规划完成修改,等出版社反馈中。一个人坚持有点枯燥。
- 12月31日,第六章仍未修改完。
- 2015年1月

2015年1月
- 1月12日凌晨,第六章、海量数据处理完成修改,交付出版社。
- 2015年4月

2015年4月
- 4月27日凌晨,交完第七章初稿,接下来编辑老师反馈,我修改审阅反馈稿。且书名由原来的《程序员编程艺术:面试和算法心得》暂时改为《编程之法:面试和算法心得》。
- 2015年5月

2015年5月
- 5月2日,开始写书的前言,大致是:为何要写这本书,写的过程是怎样的;这是本什么书,有何特色,内容是什么,为什么这么写;写给谁看,怎么看更好。当然我还会加一些自己觉得比较个性化的内容。
- 5月5日,审阅完编辑老师的第一章反馈,并合并。
- 5月6日,审阅完第二章的一半。海玲姐两位老师给出了大量细致、详尽的修改建议,包括文字表述、语言表达、标点符号、字体格式、出版规范,尤其是正斜体、大小写、上下角。
- 5月15日,和海玲姐审完第一、二章,标点、术语、表述、逻辑、图片、代码等一切细节。书稿进入一审阶段。
- 2015年6月

2015年6月
- 6月28日,经过反复修改、确认,书稿第一、二、三章基本定稿。
- 2015年7月

2015年7月
- 7月10日,书稿全部七章基本定稿,即将进入二审。
- 7月23日,补齐前言、封底、内容提要、邀请曹鹏、邹伟两位博士写推荐序,书稿进入二审,出版社重绘全部图片和公式。
- 2015年8月

2015年8月
- 8月6日,三审结束。书稿取得阶段性的胜利。
- 8月下旬,发稿审批。
- 2015年9月

2015年9月
- 9月上旬,排版校对,出胶片、印刷、装订成书
- 9月21日,几经易稿,终于敲定新书封面。
- 9月22日,开始印刷。
- 2015年10月

2015年10月
- 进入10月份,万众期待的《编程之法》,终于终于要来了!
- 10月13日晚,终于拿到第一批样书。
- 10月14日下午三点半,我的新书《编程之法》终于在异步社区上首发开卖!
Expand Down

0 comments on commit 0cc4536

Please sign in to comment.