I just feel writing self documenting code is not mutually exclusive to writing documentation and comments. My thinking is making the code itself clear means less need to stick lots of comments in it to explain what is going on. I didn't see this as meaning no comments were needed at all just that less need to be written. As regards classes and methods, those comments cover what a class or method is intended to do and not the implementation details of how it does it (unless it is really necessary or well understood e.g. LinkedList vs ArrayList).
I hope my opinions are not going to cause any tension in the company I work for but I still like adding comments to my code. On Friday, August 17, 2012 10:18:26 AM UTC+1, Carl Jokl wrote: > > I had a discussion very recently within my company regarding the source > code produced and that it has almost no comments in it. I was told quite > confidently by the developer I spoke to that this was a deliberate company > decision and that the code should be clear enough that no comments > were necessary. Also it was said that the code and methods were changing so > often that it would just be painful overhead to keep JavaDoc comments up to > date. > > I understand the principle of trying to make code self documenting and > clear enough so that it does not need lots of documentation. I am not sure > however how I feel about the idea of using this argument not to add much of > any comments at all. Am I just not with the times or Agile enough? > > What are your thoughts? > -- You received this message because you are subscribed to the Google Groups "Java Posse" group. To view this discussion on the web visit https://groups.google.com/d/msg/javaposse/-/5QHpwYf9gM8J. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/javaposse?hl=en.
