C/C++ Header file documentation -


What is the best practice you can do while creating a public header file in C ++?

  1. Should there be a short, or scaled document in the header files? I have seen almost everything for the great features of the inertient, valid parameters, return value, etc., with almost any documentation (dependent on some external documentation). I'm not sure what I want, it's great because you have always reached it, from your editor, with a very brief document on the other hand a header file often shows a complete interface on one or two pages of text It gives a better overview of what is possible with the classroom.

  2. Let's say I go with something like a short or broad document. I want some kind of jawad, where I write return values, parameters etc. What is the best conference for that in C ++? As far as I can remember that Doxygen works well with Java Dock-style documents, but is there any other conference and equipment for this, should I know before going for the Javadoc style document? Usually I use the documentation for the interface (parameter, return value, or the value of the file).

  3. does function) in the interface file (.h) in the implementation file (.c, .cpp, .m), and the documentation for implementation ( how functions is).

    I write an overview of the class before its announcement, so the reader gets the basic information immediately.

    The equipment I use is a dose of oxygen.


Comments