Option to open local documentation from code - Mendix Forum

Option to open local documentation from code

0

Summary

Add a "Go to Documentation" option to the right-click context menu and the hover summary for functions and elements. This would allow developers to jump directly to the relevant local documentation from the editor, eliminating the need to manually search through a list of functions.


The Problem

Currently, navigating to the documentation for a specific function or module often requires opening a separate extension bar or searching through a long list of available resources. When reviewing code written by others or working with unfamiliar modules, this manual process is time-consuming and disrupts the development workflow. It is inefficient to have to identify a function and then manually locate it again within a documentation tree.


Solutions


Context Menu: Right-clicking a function or element should provide a "Go to Documentation" action, similar to the existing "Go to Definition" feature.


Hover Summary: When hovering over a function, the summary tooltip could include a clickable "Open Documentation" link.


This would function similarly to the ST Lang Extension but with a direct jump capability, ensuring the documentation is always one click away from the code itself.


Benefits


Increased Productivity: Reduces the time spent switching contexts and searching for information.

Easier Onboarding: Helps developers understand legacy code or third-party modules much faster.

Improved Developer Experience: Provides a more seamless transition between writing code and referencing technical specifications.the function in your code.AX Code Right Click Menu for FunctionBlocks


asked
0 answers