🚧 TypeScript style guide: introduction.

This commit is contained in:
TinkerRobot 2021-08-08 04:02:04 +08:00
parent 92e22e6cf7
commit 803dffa932
4 changed files with 65 additions and 0 deletions

3
.gitignore vendored
View File

@ -1,3 +1,6 @@
# VS Code Config Files
.vscode/
# JetBrains Webstorm Config Files # JetBrains Webstorm Config Files
.idea/ .idea/

View File

@ -13,3 +13,4 @@
google-python-styleguide/contents google-python-styleguide/contents
google-shell-styleguide/contents google-shell-styleguide/contents
google-javascript-styleguide/contents google-javascript-styleguide/contents
google-typescript-styleguide/contents

View File

@ -0,0 +1,8 @@
谷歌 TypeScript 风格指南
################################################################################
.. toctree::
:caption: 目录
:numbered:
index

View File

@ -0,0 +1,53 @@
前言
################################################################################
.. _introduction:
简介
********************************************************************************
这份风格指南基于谷歌的内部版本,并在此基础上做了一些修改,使其具有更广泛的适用性。指南并非定期自动部署,而是由志愿者们根据需求进行维护与更新。
指南中的内容包括代码规范与最佳实践两部分。读者可根据所在团队的需求加以参考和选用。
指南中对 *必须**禁止**应当**不应**可以* 等词语的用法遵循 `RFC 2119 <https://datatracker.ietf.org/doc/html/rfc2119>`_ 中的定义。文中的所有示例均非适合实际项目的正式用法,只用于对指南中的内容加以说明。
.. _about:
翻译信息
********************************************************************************
.. _about-last-update:
上次更新日期
================================================================================
2021 年 08 月 28 日。
.. _about-author:
作者
================================================================================
* `TinkerRobot <https://github.com/tinkerrobot>`_
.. _about-original:
原文链接
================================================================================
`Google TypeScript Style Guide <https://google.github.io/styleguide/tsguide.html>`_
.. _about-translation:
中文版链接
================================================================================
`谷歌 TypeScript 风格指南 <https://zh-google-styleguide.readthedocs.io/en/latest/google-typescript-styleguide/>`_
.. _about-changelog:
修订历史
================================================================================
* **2021 年 08 月 08 日:** `TinkerRobot <https://github.com/tinkerrobot>`_ 提交了第一个版本。