I have recently introduced a simple comment convention, that could be useful for anyone, and that would be even more useful with VA support.
Let me explain: I have a large code base, and some parts are inter-related, which causes some complexity.
This is a common scenario I guess...
My system is simply to use UUIDs in comments, to create easy-to-find references by searching code.
Something like:
Somewhere:
// 7e0d25c5-1f71-45b8-480e-69d67c97521c
// some explanation (...)
Somewhere else:
// 7e0d25c5-1f71-45b8-480e-69d67c97521c
// some complementary explanation (...)
Still somewhere else:
// 7e0d25c5-1f71-45b8-480e-69d67c97521c
// some other complementary explanation (...)
Now, I just have to search my whole code base to find the related comments, hence the inter-related code sections.
Simple and effective. Creating new UUIDs is easy, they just serve as stable anchors in comments.
If VA could identify UUIDs and add them to its symbol database, then the workflow would be better
(eg. "Find References" and "Goto Related").
This is my request :)
(independently from this comment system, referencing UUIDs anywhere in a code base, could be useful anyway).