There is a standard documentation/software comments in Reactjs

Asked

Viewed 130 times

2

I’m leading a development team on Reactjs with Node.Js, and I’m having a question about how to document or comment this code so it’s nice and easy to read by other devs.

Still commenting code? Sorry the more question is that I’m old-fashioned, classic asp and Talz where everything was done like this.

Thanks for your help.

javascript node.js react documentation comments

1 answer

1

I think the code itself is only a good comment if it is a very specific function and it can generate some doubt for another dev. But the ideal is that the code is written in the best possible way so that another dev can identify what it does by just tapping the eye.

I’ve seen some component documentation libraries, in case the company has a very customized styleguide, it may be that this type of tool helps the dev a lots. Já trabalhei com a Docz: [https://www.docz.site/] Bem prática, dinâmica e com bastante pull requests of the community.

And I think the part, it’s important to have robust documentation regarding the product’s business rule so that dev`s can consult when needed.

Browser other questions tagged javascript node.js react documentation comments

You are not signed in. Login or sign up in order to post.