Visual Studio Code (IntelliSense) Integration

Functionality to add/problem to solve

There are no good instructions on how to use IntelliSense in VS Code to work properly with OpenFOAM source code. By "work properly" I mean code completion and suggestions. I was able to hack something together for OpenFOAM 2.1.1 by simply adding the src directory into include path. I have failed to do the same for OpenFOAM v1706. I get a lot of "incomplete class type is not allowed" which signals that it is probably an include path issue. From my limited understanding I get that OpenFOAM has a complicated code base and IntelliSense needs a little help making sense of it.

Target audience

Every researcher who develops code for OpenFOAM.

Proposal

Could you please release the instructions on how to make IntelliSense in VS code to work with OpenFOAM (c_cpp_properties.json, settings.json, etc.) by adding it to your wiki? I do not think that OpenFOAM is being developed in notepad, meaning that there is definitely a way to make this work! :-)

Maybe you are using something other than VS Code internally. That would also work.

What does success look like, and how can we measure that?

Should be self-explanatory.

Links / references

There are many guides like this one which switch IntelliSense into Tag parsing mode, which defeats the whole purpose of using IntelliSense in the first place.

Funding

Should be self-explanatory.