Comments on: What Is Your Code Saying? http://openlandscape.wordpress.com/2008/08/09/53/ Living and Solving The Mystery Thu, 12 Nov 2009 17:27:30 +0000 http://wordpress.com/ hourly 1 By: openlandscape http://openlandscape.wordpress.com/2008/08/09/53/#comment-88 openlandscape Sat, 16 Aug 2008 09:49:38 +0000 http://openlandscape.wordpress.com/?p=53#comment-88 Thanks for the link. I'll definitely give it a read. However I'd like to point out that in this case I almost feel that comments get second place next to a proper, fluid interface for properties and methods. The source code should almost read like a kind of natural text, as opposed to having hundreds of unencapsulated "if" statements all over the place. In fact everytime a developer uses an "if" statement, he is creating a new business rule. The question the developer needs to ask himself, is whether this rule will be used outside of the scope of the current operation. If so, chuck it into a proper method/property, with a name that will facilitate a fluid interface. It doesn't matter if it's used as little as 2 or 3 times elsewhere, the point is that a descriptive operation name is used to clarify what that "if" statement means. So as soon as you have an "if" statement with "|" and "&" you really need to consider if it's meaning is still clear. Thanks for the link. I’ll definitely give it a read.

However I’d like to point out that in this case I almost feel that comments get second place next to a proper, fluid interface for properties and methods. The source code should almost read like a kind of natural text, as opposed to having hundreds of unencapsulated “if” statements all over the place.

In fact everytime a developer uses an “if” statement, he is creating a new business rule. The question the developer needs to ask himself, is whether this rule will be used outside of the scope of the current operation. If so, chuck it into a proper method/property, with a name that will facilitate a fluid interface. It doesn’t matter if it’s used as little as 2 or 3 times elsewhere, the point is that a descriptive operation name is used to clarify what that “if” statement means. So as soon as you have an “if” statement with “|” and “&” you really need to consider if it’s meaning is still clear.

]]> By: Willie Roberts http://openlandscape.wordpress.com/2008/08/09/53/#comment-82 Willie Roberts Sat, 09 Aug 2008 12:36:44 +0000 http://openlandscape.wordpress.com/?p=53#comment-82 I wrote an article last year around a similiar topic, however the best example of this I have ever read is a PDF book called Comments are for Weenies published by the authors of SharpDevelop. http://www.sharpdevelop.com/TechNotes/ I wrote an article last year around a similiar topic, however the best example of this I have ever read is a PDF book called Comments are for Weenies published by the authors of SharpDevelop.

http://www.sharpdevelop.com/TechNotes/

]]>