Comments on Profile Post by Milena

  1. orlando
    orlando
    No it isn't. There is objectively bad documentation, and if it is objectively bad it is worth improving.
    Jan 11, 2016
  2. EternalShadow
    EternalShadow
    Actually, the point of docs is to educate on something that CANNOT be found in textbooks and tutorials... Most textbooks and tutorials cover very basic concepts, while docs are meant to tell you how the programmer has done a certain thing, and how the end user is meant to use the said code...
    Jan 11, 2016
  3. orlando
    orlando
    Bad documentation just wastes everyone's time by making them invest lots of effort to find out stuff that should be properly documented.


    An example for that would be the JS api docs of RPG Maker MV ;-)
    Jan 11, 2016
  4. Iavra
    Iavra
    Wait, the MV API is documented? :p
    Jan 11, 2016
  5. Hudell
    Hudell
    There's no better documentation than the code itself :)
    Jan 11, 2016
  6. orlando
    orlando
    That's incorrect. A proper documentation would be made with something like doxygen and would provide a proper way to navigate all the classes with extensive descriptions.


    Some people like the fairy tale of code that is so well-written, it doesn't need any comments or documentation, but beyond the most trivial code that's simply not a real thing.
    Jan 11, 2016
  7. Hudell
    Hudell
    Well, I live in a fairy tale then.
    Jan 12, 2016