playbook/docs/index.md

45 lines
1.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 文档导航Docs Index
本仓库文档按“跨语言共识 / 语言专属”分层组织,便于在多语言项目中扩展与复用。
## 跨语言common
- 提交信息与版本号:`common/commit_message.md`
## TSLtsl/tsf
- TSL 源文件后缀同时包含:`.tsl`(脚本)与 `.tsf`(模块/库代码)。
- TSL 总入口(先判断主问题属于哪一层):`tsl/index.md`
- 代码风格:`tsl/code_style.md`
- 命名规范:`tsl/naming.md`
- 语法手册(只处理“语言怎么写”):`tsl/syntax/index.md`
- 金融业务入口(指标、选股、回测与策略流程):`tsl/finance/index.md`
- 模块与集成入口pyTSL、微信消息、Python 互操作、回测框架):`tsl/modules/index.md`
- 函数检索入口(模块目录位于 `tsl/reference/catalog/``tsl/reference/index.md`
- 工具链与验证命令(模板):`tsl/toolchain.md`
## C++cpp
- 代码风格:`cpp/code_style.md`
- 命名规范:`cpp/naming.md`
- 工具链与验证命令(模板):`cpp/toolchain.md`
- 第三方依赖Conan`cpp/dependencies_conan.md`
- clangd 配置:`cpp/clangd.md`
## Pythonpython
- 代码风格:`python/style_guide.md`
- 工具链:`python/tooling.md`
- 配置清单:`python/configuration.md`
## TypeScripttypescript
- 代码风格:`typescript/code_style.md`
- 命名规范:`typescript/naming.md`
- 工具链:`typescript/toolchain.md`
- 配置清单:`typescript/configuration.md`
## Markdownmarkdown
- 代码块与行内代码格式:`markdown/index.md`