Comments on: The pyramid of code quality, the 5 characteristics of good code. http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/ Thu, 29 Jul 2010 10:36:55 -0600 http://wordpress.org/?v=2.8.3 hourly 1 By: Forget about Hope Driven Development (HDD), the cancer of software development. | Making good software http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-787 Forget about Hope Driven Development (HDD), the cancer of software development. | Making good software Thu, 13 Aug 2009 01:42:21 +0000 http://makinggoodsoftware.com/?p=143#comment-787 [...] care about your code quality, then improve the [...] [...] care about your code quality, then improve the [...]

]]> By: 5 Tips for creating good code every day; or how to become a good software developer | Making good software http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-729 5 Tips for creating good code every day; or how to become a good software developer | Making good software Thu, 06 Aug 2009 12:37:00 +0000 http://makinggoodsoftware.com/?p=143#comment-729 [...] To be proud of the solution; it is not just any solution, it is a good solution. It follows the principles of the “Pyramid of the software quality“. [...] [...] To be proud of the solution; it is not just any solution, it is a good solution. It follows the principles of the “Pyramid of the software quality“. [...]

]]> By: 5 Tips for creating good code every day, how to become a good software developer « Making Good Software http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-51 5 Tips for creating good code every day, how to become a good software developer « Making Good Software Fri, 15 May 2009 10:36:59 +0000 http://makinggoodsoftware.com/?p=143#comment-51 [...] To be proud of the solution, it is not any solution, it is a good solution. It follows the principles of the “Pyramid of the software quality“. [...] [...] To be proud of the solution, it is not any solution, it is a good solution. It follows the principles of the “Pyramid of the software quality“. [...]

]]> By: Forget about Hope Design Driven (HDD), the cancer of software development. « Making Good Software http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-50 Forget about Hope Design Driven (HDD), the cancer of software development. « Making Good Software Tue, 12 May 2009 23:10:46 +0000 http://makinggoodsoftware.com/?p=143#comment-50 [...] care about your code quality, then improve the [...] [...] care about your code quality, then improve the [...]

]]> By: Alberto G http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-49 Alberto G Mon, 11 May 2009 14:32:31 +0000 http://makinggoodsoftware.com/?p=143#comment-49 @ twistedmind: Thanks for your comment, actually the idea of the pyramid was an image I always had on my head to represent the code quality, I've never seen any previous reference... and about the book "Clean code" I have actually just ordered from amazon I've heard very good reviews about it, I'm looking forward to read it. @ twistedmind: Thanks for your comment, actually the idea of the pyramid was an image I always had on my head to represent the code quality, I’ve never seen any previous reference… and about the book “Clean code” I have actually just ordered from amazon I’ve heard very good reviews about it, I’m looking forward to read it.

]]> By: twistedmind http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-48 twistedmind Mon, 11 May 2009 14:19:22 +0000 http://makinggoodsoftware.com/?p=143#comment-48 Very good diagram, illustrates what good software 'is'. Are there any references for the pyramid? I immediately though of the book Clean code. Very good diagram, illustrates what good software ‘is’. Are there any references for the pyramid?
I immediately though of the book Clean code.

]]> By: Jonathan Hartley http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-47 Jonathan Hartley Sun, 10 May 2009 22:03:27 +0000 http://makinggoodsoftware.com/?p=143#comment-47 Hey Alberto, thanks for the response. I really wonder about how best to discuss the comments thing. I've spent so many years so deeply knowing and feeling that 'comments == good', that it's difficult now to wonder whether I was simply wrong all those years, or whether there are particular environments where it's more true and others where it's less true. I guess I am currently working in a place that is possibly a close-to-ideal sort of situation for abandoning comments. We are a small team (currently 7) with relatively high standards (everyone is smarter than me.) We pair program on almost everything and switch pairs every day, so we have all grown to know the entire project quite thoroughly. We seem to assimilate new-hires and interns quite quickly, so I think the code really is comprehensible without comments - not *just* that we're all so familiar with it that we don't need them. I think we are making the right decision for us, to abandon comments, but perhaps it would not be the right decision for other teams in other circumstances. Hey Alberto, thanks for the response. I really wonder about how best to discuss the comments thing. I’ve spent so many years so deeply knowing and feeling that ‘comments == good’, that it’s difficult now to wonder whether I was simply wrong all those years, or whether there are particular environments where it’s more true and others where it’s less true.

I guess I am currently working in a place that is possibly a close-to-ideal sort of situation for abandoning comments. We are a small team (currently 7) with relatively high standards (everyone is smarter than me.) We pair program on almost everything and switch pairs every day, so we have all grown to know the entire project quite thoroughly. We seem to assimilate new-hires and interns quite quickly, so I think the code really is comprehensible without comments – not *just* that we’re all so familiar with it that we don’t need them.

I think we are making the right decision for us, to abandon comments, but perhaps it would not be the right decision for other teams in other circumstances.

]]> By: The pyramid of code quality (Part II), the 3 different types of codes. « Making Good Software http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-46 The pyramid of code quality (Part II), the 3 different types of codes. « Making Good Software Sun, 10 May 2009 15:06:37 +0000 http://makinggoodsoftware.com/?p=143#comment-46 [...] on the previous article, we have seen that the code can be seen as pyramid where its base is formed by the characteristics that make the code robust and future-proof and the [...] [...] on the previous article, we have seen that the code can be seen as pyramid where its base is formed by the characteristics that make the code robust and future-proof and the [...]

]]> By: Alberto G http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-45 Alberto G Sun, 10 May 2009 11:25:15 +0000 http://makinggoodsoftware.com/?p=143#comment-45 Hi Jonathan! I really admire the direction you are taking in your team, I have to admit that I was skeptic when I first heard about comments being evil, but after seen a few examples I have to admit that it really works. Hi Jonathan!

I really admire the direction you are taking in your team, I have to admit that I was skeptic when I first heard about comments being evil, but after seen a few examples I have to admit that it really works.

]]> By: Jonathan Hartley http://www.makinggoodsoftware.com/2009/05/07/the-pyramid-of-code-quality-the-5-characteristics-of-good-code/comment-page-1/#comment-44 Jonathan Hartley Sun, 10 May 2009 01:00:58 +0000 http://makinggoodsoftware.com/?p=143#comment-44 Hey, nice post. With regard to comments and readability: I work at a small agile start-up where we have finally decided that comments, in the general case, are evil. We've dubbed them "lies" and have each decided to more-or-less stop using them, because they get out of date and mislead people about the intentions of the code. We have decided that code should be made readable with its structure and naming, without comments. We do still use comments in cases where there really is no other way, but it is about 1 line of comments per few hundred lines of code. Hey, nice post.

With regard to comments and readability:

I work at a small agile start-up where we have finally decided that comments, in the general case, are evil. We’ve dubbed them “lies” and have each decided to more-or-less stop using them, because they get out of date and mislead people about the intentions of the code.

We have decided that code should be made readable with its structure and naming, without comments.

We do still use comments in cases where there really is no other way, but it is about 1 line of comments per few hundred lines of code.

]]>