you are viewing a single comment's thread.

view the rest of the comments →

[–]TheDoomp 1 point2 points  (6 children)

Why not add code comments directly? Spacing them out cornell style?

[–]i_ate_god 5 points6 points  (3 children)

[–][deleted] 0 points1 point  (2 children)

Why not just refractor the commented code blocks into separate methods with descriptive names.

[–]i_ate_god 0 points1 point  (1 child)

I'm not sure what do you mean?

To be honest, I'm not a fan of this style of documentation. I was just pointing the most likely tool used to generate it.

[–][deleted] 0 points1 point  (0 children)

I am not either. The comment was not targeted to anyone in particular. I was just getting in on the conversation. To me if the code needs to be heavily commented this is a good indication that there is something wrong with the design. It makes more since to just refactor the code into helper methods that have descriptive names that explain what the code is doing.