Skip to content

Feature request: auto open and navigate map when exploring code #1

@PFight

Description

@PFight

Thanks for product, it is what I trying to find!

For my use case, there are missing features:

  • Open mind maps, associated with viewing source code fiile.
    Code can have several associated mind maps, because several features can use it. So, when developer opens source file, it should higlight all mind maps, that associated with it.
  • Navigate to mind map node, when cursor focused on some linked code

I want to use CodeMindMap as inline documentation for the code architecture. The main problem with such documentation - its keep it "at place" and actual. Developers often don't know, is there some documentation for specific code or not. If documentation is somewhere far away, it will be forgotten and obsolete. That's why documentation should be near to code, so when you inspecting the code, documentation appears in your attention. In that case developer will find this documentation, use it to understand the code, and actualize, if it going to change the code.

The main difference CodeMindMap from comments in code - it is architecture view. It can describe interaction of several modules in one process, giving bird-fly overview of whole feature implementation. It can't be achieved by comments in code, but it most critical documentation. Every smart developer can more or less quick understand some function logic. But it is no so easy to understand architecture of several modules, that iteracts. It is also dificult to find required module in such complex system, to make bugfix or feature implementation. One shoulld investigate several modules, traverse function calls, understand all that code to find one function, that is needed. Mind map can help make it faster, having global overview and code links.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions