Quote:
Originally Posted by Fаng
So you're saying my entire college, UCI, all of the books I've read on different programming langauges, and all of the people I've met so far in industry have no idea what they're talking about? I am not changing my documentation style. It's excessive as it is. I'm not going to argue about ridiculous things like this.
|
Hopefully, not all the people who are coding have the same mentality than the people around you :rolleyes: As I said, you're not documenting, you are commenting your code. And it's totally different. The C# language offers a powerful tools for documentation: summaries. Java offers a powerful tools for documentation: javadoc. Languages like C++ don't have documentation, but only comments, so, people made some tools like dOxygen. Oh, but they loose their time as it is so useless to use documentation... After all, there is the « Go to definition » option in some IDE. Sorry, but I don't want to go throughout all the header files, or all the source files to understand how to use the API. Anything public must be documented.
Where I work, there is this guideline:
Code:
Documenting
Document header files using dOxygen. Favor the @command format to the \command one
In fact, most people think like you. Some comments will do the job. But, eh, the VPs aren't happy of that. Each time someone want to use the API of someone else, he has to look in the entire header. When someone asked me how to use a module I did ? I just generated the HTML documentation of the module, and bam, you got a MSDN-like things to know how to use the API.
In C#, in Java, it is way better because you have things like IntelliSense which use the summaries/javadoc to show you all the information on the functions, members, etc.
That's better for people using your code. The code is clearer. And no, it doesn't allow people to use stupid naming. But, until you work with someone, it won't change anything...
------
Anyway, as you won't change your idea on that. (Which is your problem) Another point.
What is the idea to expose your variables to everyone ? All your variables which should be controlled with accessors are totally public ? What a good way to break the code...