Sí, claro que lo es.
El estilo formal o informal nunca es el problema con los comentarios. Sin embargo, hay otros problemas:
1) A mucho. Cuando reviso el código heredado, no quiero leer un ensayo sangriento. No te excedas.
2) Comentarios que están mal. Si documentó el comportamiento en un comentario y luego lo cambió pero dejó el comentario, me llevará por el camino equivocado. Eso es malo.
3) Efectos secundarios indocumentados. Si su código tiene un efecto secundario (cambia el estado global directamente), definitivamente vale la pena comentarlo.
4) Código inacabado. Si falta un paso, que tenga en mente para volver más tarde, agregue un TODO donde debería estar.
Pero mucho más que comentarios, asegúrese de que sus variables y funciones documenten lo que hacen con un nombre claro. En un nuevo proyecto, prefiero documentar qué hará una función escribiendo pseudocódigo como comentarios, pero a medida que implemento cada paso, elimino los comentarios.
- ¿Conoces algún complemento de WordPress que te ayude a abrir dos enlaces con un solo clic?
- ¿Es una buena idea, o cuáles serían las desventajas de construir una red social usando Node js, Express js como back end y Angular js como front end?
- ¿Dónde puedo obtener respuestas gratuitas sobre desarrollo web, de profesionales?
- ¿Cómo y dónde alojar una aplicación de rieles?
- Al desarrollar un sitio web desde cero, ¿tengo que hacer tanto la codificación del lado del cliente como del lado del servidor?
Finalmente, si su equipo usa algo como JSDoc para documentar, por supuesto, sería un gran problema si rompe el formato, por lo que la documentación no se puede representar correctamente. Eso no es tanto una cuestión formal / informal, sino que el código debe seguir la API.
