introduction

Author: beginor

README.md

@@ -3,6 +3,8 @@
 Clean Code concepts adapted for TypeScript.  
 Inspired from [clean-code-javascript](https://github.com/ryanmcdermott/clean-code-javascript).
 
+将代码整洁的理念适配至 TypeScript ， 灵感来自于[代码整洁的 JavaScript ](https://github.com/ryanmcdermott/clean-code-javascript)。
+
 ## Table of Contents
 
   1. [Introduction](#introduction)
@@ -17,6 +19,20 @@ Inspired from [clean-code-javascript](https://github.com/ryanmcdermott/clean-cod
   10. [Formatting](#formatting)
   11. [Comments](#comments)
 
+## 目录
+
+  1. [简介](#简介)
+  2. [变量](#变量)
+  3. [函数](#函数)
+  4. [对象和数据结构](#对象和数据结构)
+  5. [类](#类)
+  6. [SOLID](#solid)
+  7. [测试](#测试)
+  8. [并发](#并发)
+  9. [错误处理](#错误处理)
+  10. [格式化](#格式化)
+  11. [评论](#评论)
+
 ## Introduction
 
 ![Humorous image of software quality estimation as a count of how many expletives
@@ -45,9 +61,29 @@ shaped into its final form. Finally, we chisel away the imperfections when
 we review it with our peers. Don't beat yourself up for first drafts that need
 improvement. Beat up the code instead!
 
-**[⬆ back to top](#table-of-contents)**
+## 简介
+
+![一张用你阅读代码时吐槽的数量来评估软件质量的搞笑图片](https://www.osnews.com/images/comics/wtfm.jpg)
+
+将源自 Robert C. Martin 的 [*Clean Code*](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882)
+的软件工程原则适配到 TypeScript 。 这不是一个代码风格指南， 它是一个使用 TypeScript 来生产
+可读的， 可重用的， 以及可重构的软件的指南。
+
+这里的每一项原则都不是必须遵守的， 甚至只有更少的能够被广泛认可。 这些仅仅是指南而已， 但是却是
+*Clean Code* 作者多年经验的结晶。
+
+我们的软件工程行业只有短短的 50 年， 依然有很多要我们去学习。 当软件架构与建筑架构一样古老时，
+也许我们将会有硬性的规则去遵守。 而现在， 让这些指南做为你和你的团队生产的 TypeScript 代码的
+质量的标准。
+
+还有一件事： 知道这些指南并不能马上让你成为一个更加出色的软件开发者， 并且使用它们工作多年也并
+不意味着你不再会犯错误。 每一段代码最开始都是草稿， 像湿粘土一样被打造成最终的形态。 最后当我们
+和搭档们一起审查代码时清除那些不完善之处, 不要因为最初需要改善的草稿代码而自责， 而是对那些代
+码下手。
+
+**[⬆ 返回目录](#目录)**
 
-## Variables
+## Variables 
 
 ### Use meaningful variable names