Maybe let’s start with the question: Why? Are you planning to write an operating system from scratch? What would be the benefits of such project?
If you have a specific answer, such as “I want to make an OS that is provably 100% safe and never crashes”, that will have an impact on your choice of tools. (If you don’t have a specific answer, then what’s the point?)
I think it might be a better idea to have the tool auto document your fields and try to infer from the param names, fn names, return names, etc. to figure out what the field is trying to do. And to allow the programmer to override the autodocs with Doc comments or something. The IDE would then hide all non essential comments by default, such as those not right above a field.
I think this misses the point of documentation. If the tool automatically creates comments based on the function names, and then the IDE hides those comments… why even have them in the first place?
Good documentation describes intent, things that are not obvious from looking at the code, and maybe examples of usage. Long documentation should be foldable in IDE; many IDEs already have this function.
Maybe let’s start with the question: Why? Are you planning to write an operating system from scratch? What would be the benefits of such project?
If you have a specific answer, such as “I want to make an OS that is provably 100% safe and never crashes”, that will have an impact on your choice of tools. (If you don’t have a specific answer, then what’s the point?)
I think this misses the point of documentation. If the tool automatically creates comments based on the function names, and then the IDE hides those comments… why even have them in the first place?
Good documentation describes intent, things that are not obvious from looking at the code, and maybe examples of usage. Long documentation should be foldable in IDE; many IDEs already have this function.