V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
WEBUG
V2EX  ›  程序员

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

  •  
  •   WEBUG · 2020-11-05 09:47:43 +08:00 · 1419 次点击
    这是一个创建于 1481 天前的主题,其中的信息可能已经有所发展或是发生改变。
    想要研究一个开源项目,需要整理项目的文档方便后续开发。怎么更好熟悉目录结构。想找个工具记录下代码目录。
    5 条回复    2020-11-05 14:43:51 +08:00
    labulaka521
        1
    labulaka521  
       2020-11-05 09:48:57 +08:00 via iPhone
    fork
    readme
    WEBUG
        2
    WEBUG  
    OP
       2020-11-05 09:52:48 +08:00
    @labulaka521
    fork 过了
    准备写 readme 之类的文档,
    代码的目录很多,就是想有没有什么直观的方式表现出目录结构,或者之间的关系,类似一个思维导图之类的方式,方便后来人接手后看下文档快速知道要修改什么功能去哪个目录下看这种
    SuperXRay
        3
    SuperXRay  
       2020-11-05 10:26:49 +08:00
    你可能需要用`tree`命令输出目录树,复制目录树备注目录作用
    clf
        4
    clf  
       2020-11-05 10:38:51 +08:00
    代码目录分层+有效的目录名,一般采用常见的目录名都还好理解的。但前往别搞个拼音 /首字母来当目录名字。
    siteshen
        5
    siteshen  
       2020-11-05 14:43:51 +08:00
    1. 确定项目使用的编程语言;
    2. 找能分析该语言依赖,并能输出文档 /图片的工具;
    3. 运行该工具。
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1634 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 27ms · UTC 16:51 · PVG 00:51 · LAX 08:51 · JFK 11:51
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.