Thanks for the input but perhaps I should give you a clearer idea of what I'm trying to accomplish.
So, I'll give you a very simple example of what I mean by taking a look at just one line in the code:
$WhateverModule::VERSION = '0.8';
As someone who is pretty much a newb to versioning, this single line raises many questions for me. I've seen many different ways of doing versions in code and it's confusing to me. And I wonder how this way of getting the version into the code was settled on by the distribution. So I do a little googling and find two interesting articles related how to properly version your modules and I read them. I want to reference these articles in my notes about this particular line of code. And I did not know until recently that this line is automatically generated by some distribution generation software. So I want to also put that in my notes about this line as well.
So, even with this one simple line, there can be quite a lot of knowledge laying hidden below it that is not readily obvious unless you are very experienced. I want to be able to easily reveal this kind of "hidden" knowledge in my annotations and six months later, after I might have forgotten, be able to refer to these notes.
|