有没有什么工具能方便标注/表现出 代码各个目录的功能

2020-11-05 09:47:43 +08:00
 WEBUG
想要研究一个开源项目,需要整理项目的文档方便后续开发。怎么更好熟悉目录结构。想找个工具记录下代码目录。
1358 次点击
所在节点    程序员
5 条回复
labulaka521
2020-11-05 09:48:57 +08:00
fork
readme
WEBUG
2020-11-05 09:52:48 +08:00
@labulaka521
fork 过了
准备写 readme 之类的文档,
代码的目录很多,就是想有没有什么直观的方式表现出目录结构,或者之间的关系,类似一个思维导图之类的方式,方便后来人接手后看下文档快速知道要修改什么功能去哪个目录下看这种
SuperXRay
2020-11-05 10:26:49 +08:00
你可能需要用`tree`命令输出目录树,复制目录树备注目录作用
clf
2020-11-05 10:38:51 +08:00
代码目录分层+有效的目录名,一般采用常见的目录名都还好理解的。但前往别搞个拼音 /首字母来当目录名字。
siteshen
2020-11-05 14:43:51 +08:00
1. 确定项目使用的编程语言;
2. 找能分析该语言依赖,并能输出文档 /图片的工具;
3. 运行该工具。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/721912

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX