How to generate API documents for some frameworks and libraries

how are the API documents for some frameworks and libraries generated?

recently to do a sdk api document, do not know how to do, the document has a quick start, tutorials, and specific API document, add up to 500 more than the content, it is impossible to write one by hand. I would like to ask if anyone knows how similar frameworks and libraries are generated and managed, such as VUE , react these official documents are done, is there a specific framework or library, please provide a general idea. I studied it for a long time, but I didn"t understand it.


document content must be handwritten


js library documents are generally written by themselves, and comments are rarely automatically generated. Documents at the back end of
java are usually automatically generated through comments or log .


api documents are generally written in code comments, written in the prescribed format, and then converted into documents through the corresponding tools.
other tutorials and so on, have to write their own. Of course, these can be modified ready-made, and there is no need to write them completely from scratch, at least structurally, there is no need to rewrite


    .
  • the content of the document must be handwritten. Whether it's comments, md, or whatever, it's all handwritten
  • .
  • the process of generating a website can be done with the help of frameworks, such as jsdoc,tsdoc, etc.
  • if it is a typed language, such as typescript, which does not write anything, you can generate a type reference website, but it is stiff and can be used only for internal use, such as getting started, tutorials, or handwriting. I usually just create a docs folder directory directly and write
  • with md.

gitbook.


JSDoc introduction


Sphinx can automatically get docstring comments in the code and automatically generate documents


currently using

http://apidocjs.com

use gitbook or hexo to write those documents; you can visit my github: https://github.com/Samdyddd

.
Menu