Documenting Code Elements

  • Hi all,

    I’m using Notepad++ to edit GAMS code, and have set up syntax highlighting etc for it. My model is very large, with a lot of sets, parameters, variables, equations, etc that I want to document. What I’d really like is a way to write a description for each variable in the code, and have that description show in a separate window / pane in Notepad++ whenever that particular variable is highlighted.

    I’ve looked at a lot of other code editors / IDEs, and some of these do this with languages like Java and C++ (e.g. IntelliJ), but they seem to be specific to those languages, and revolve around using complicated tools or self documenting systems like JavaDocs. I just want to type a description for my variables and have those descriptions show up when needed.

    Does anyone know if this is possible in Notepad++? If not, are there other editors that might do this? Please note I’m not looking to learn systems for languages I don’t use, like Java, C#, C++ etc.

    Many thanks!!

Log in to reply