Errata for the Framework Design Guidelines

re: Errata for the Framework Design Guidelines

shawn — Thu, 09 Feb 2006 17:27:53 GMT

[page 153, first DO]

As the example does not accept null as value for item, the method Add should check at the beginning whether item is null to throw ArgumentNullException.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Thu, 09 Feb 2006 17:03:53 GMT

[page 152, ANTHONY MOORE]

I can't find CodeTypeReference.IsGlobal from MSDN help.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Thu, 09 Feb 2006 16:56:27 GMT

It seems that the CONSIDER (page 152) can be simplified to:

CONSIDER using Booleans for constructor parameters that are simply used to initialize Boolean properties.

Furthermore, it's really hard to believe that some crazy guy wants to pass-in enum or integral values to initialize Boolean properties.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Wed, 08 Feb 2006 19:28:29 GMT

Typo: page 113, line 6, second word, "though", should be "through".

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Wed, 08 Feb 2006 16:03:59 GMT

Given section 5.7.5, "Pointer Parameters", I would think that the DO NOT on page 149 should be "AVOID" instead. Or it should be broken into two sub rules, one is DO NOT, another AVOID.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Wed, 08 Feb 2006 15:55:15 GMT

I would suggest to give every single rule in the guideline a number for easy discussion.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Wed, 08 Feb 2006 07:13:27 GMT

AVOID on page 156, the first sentence should read:

"Using out or ref parameters requires experience with pointers, understand how pass-by-value and pass-by-reference differ, and handling methods with multiple return values.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Tue, 07 Feb 2006 18:50:14 GMT

Page 107, the comment from BRAD ABRAMS, I guess there is a typo in the last sentence, which should read:

As you see in section 5.7.1, [an enum] argument would make it easier to understand code calling this API.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Tue, 07 Feb 2006 12:55:10 GMT

CONSIDER on page 186 refers to the wrong section.

Shawn Cheng

re: Errata for the Framework Design Guidelines

shawn — Tue, 07 Feb 2006 11:39:49 GMT

On page 197, I would agree with JEFFREY RICHTER at some degree, and would think that if the DO is changed to CONSIDER, many of us would feel better.

Shawn Cheng