angularjs - What are best practices for documenting MEAN stack web applications? -
i java programming background. know how documentation there. can document each method , each attribute of class in java environment.
since last year, have been working on web application using mean stack. @ first, added single-line comments own understanding. think there should standard way of documenting web applications.
roughly, have following code:
- angularjs controllers
- angularjs routes
- angularjs services
- mongodb collections defined on server side (node)
- expressjs configuration code
- expressjs routes , handlers
- rest api
- socket.io code
in short, want this:
- documentation inside code in form of comments (standard way)
- make separate documentation word file or html file
edit
i don't mean want similar type of code documentation done in java. want understand how in mean based applications in standard way. use mean boilerplates know there separate folders client side code , server side code. within them, there separate folders configuration, route handlers, authentication, views etc.
thanks.
Comments
Post a Comment