Comments on: Seven Truths of Good Code http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code Stories of a Self-published, Entrepreneurial Fiction Author (née Software Guy) Mon, 08 Sep 2008 10:38:20 +0000 http://wordpress.org/?v=2.3.1 By: Kris http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9901 Kris Sat, 02 Dec 2006 02:52:26 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9901 I really enjoyed this post... I'll refrain from printf argument but you made some great points that everyone should keep in mind as they develop. I really enjoyed this post… I’ll refrain from printf argument but you made some great points that everyone should keep in mind as they develop.

]]> By: shiftMode » Blog Archive » Good Code http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9676 shiftMode » Blog Archive » Good Code Wed, 22 Nov 2006 00:08:02 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9676 [...] I’d have to wholeheartedly agree on Tim’s seven truths of good code… [...] […] I’d have to wholeheartedly agree on Tim’s seven truths of good code… […]

]]> By: Seven Truths Of Good Code - rukh.de http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9516 Seven Truths Of Good Code - rukh.de Wed, 15 Nov 2006 12:48:36 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9516 [...] J. Timothy King writes about Seven Truths Of Good Code. Seven good points on how to separate source and data. He explains why it is a bad idea to use hardcoded data if you could create a variable for it. There is also one point about good commenting. [...] […] J. Timothy King writes about Seven Truths Of Good Code. Seven good points on how to separate source and data. He explains why it is a bad idea to use hardcoded data if you could create a variable for it. There is also one point about good commenting. […]

]]> By: Jonathan Allen http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9511 Jonathan Allen Wed, 15 Nov 2006 08:04:25 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9511 prinftf is not a implementation of the MVC concept. It has nothing to do with the MVC concept, as anyone who even considered reading the original SmallTalk paper on MVC knows this. prinftf is not a implementation of the MVC concept. It has nothing to do with the MVC concept, as anyone who even considered reading the original SmallTalk paper on MVC knows this.

]]> By: J. Timothy King http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9497 J. Timothy King Tue, 14 Nov 2006 20:21:50 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9497 You're confusing the <em>data</em> being printed with the <em>symbol</em> used to represent that data. Yes, the data to be printed should absolutely be separate from the format. But the symbol used to represent that data is closely related to the format, especially if the format refers to a data type in a strongly typed language like C++. Some examples: BAD: <blockquote><pre>cout << "My name is Tim. I am 12 years old, 4'10\", 80 pounds." " (Not really. This is just an example.)" << endl;</pre></blockquote> GOOD: <blockquote><pre>const person_t& me = get_author(); cout << "My name is " << me.name() << ". " << "I am " << me.age() << " years old, " << feet(me.height()) << "'" << inches(me.height()) << "\", " << me.weight() << " pounds." << (me.is_real()? "" : " (Not really. This is just an example.)") << endl;</pre></blockquote> NOT SO GOOD: <blockquote><pre>const person_t& me = get_author(); printf("My name is %s. I am %d years old, %d'%d\", %d pounds.%s\n", (const char*)(me.name().c_str()), (int)(me.age()), (int)(feet(me.height())), (int)(inches(me.height())), (int)(me.weight()), (me.is_real()? "" : " (Not really. This is just an example.)"));</pre></blockquote> Let's say I want to insert a field for my eye color. Make that change to the <em>cout</em>-style and <em>printf</em>-style formats, and tell me which is easier to keep straight. -TimK You’re confusing the data being printed with the symbol used to represent that data. Yes, the data to be printed should absolutely be separate from the format. But the symbol used to represent that data is closely related to the format, especially if the format refers to a data type in a strongly typed language like C++.

Some examples:

BAD:

cout << "My name is Tim. I am 12 years old, 4'10\", 80 pounds."
  " (Not really. This is just an example.)" << endl;

GOOD:

const person_t& me = get_author();
cout << "My name is " << me.name() << ". "
  << "I am " << me.age() << " years old, "
  << feet(me.height()) << "'" << inches(me.height()) << "\", "
  << me.weight() << " pounds."
  << (me.is_real()? "" : " (Not really. This is just an example.)")
  << endl;

NOT SO GOOD:

const person_t& me = get_author();
printf("My name is %s. I am %d years old, %d'%d\", %d pounds.%s\n",
  (const char*)(me.name().c_str()), (int)(me.age()),
  (int)(feet(me.height())), (int)(inches(me.height())),
  (int)(me.weight()),
  (me.is_real()? "" : " (Not really. This is just an example.)"));

Let’s say I want to insert a field for my eye color. Make that change to the cout-style and printf-style formats, and tell me which is easier to keep straight.

-TimK

]]> By: Anonymous http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9496 Anonymous Tue, 14 Nov 2006 18:59:11 +0000 http://blog.jtimothyking.com/2006/11/14/seven-truths-of-good-code#comment-9496 I mostly agree, except about printf format strings. The data being printed and the format it is printed in are distinct, and should be separate. printf is basically an implementation of the MVC concept. I mostly agree, except about printf format strings. The data being printed and the format it is printed in are distinct, and should be separate. printf is basically an implementation of the MVC concept.

]]>