cntehang / public-dev-docs

develop docs.
Apache License 2.0
43 stars 10 forks source link

代码风格指南 制定计划 #1

Closed danranVm closed 5 years ago

danranVm commented 6 years ago

代码风格指南

需要产出或改动的文件

dev-docs/frontend 目录下

该目录下的文件适用于整个前端开发,所以应该存放的是TypescriptAngular的 style guide

project(web-te-yi-xing)/docs 目录下

该目录的文件适用的web-te-yi-xing项目开发,使用的是 Ng Alain UI 框架,参考了 Alain 提供的一些建议以及结合项目组开发成员的一些约定。

参考资料

其中,typescript-coding-standard.md 文件已经存在,只需要把参考资料中属于Typescript有价值并且原文件中没有的内容添加进去。
angular-style-guide.md 文件则需要从后 3 个参考资料中把属于Angular并且有价值的内容添加进去。
project-style-guide.md 文件是上述两个文件的一个针对性补充,在遵循它们的前提下,针对 Alain 的建议和项目组成员的约定给出文档性总结。

danranVm commented 5 years ago

已整理