> > Returns the result of calling F2(). > > > > This then allows them to view F2's documentation in turn, to > see what THAT > > does - they can follow the chain to find what they need to know. > > No. that's break encapsulation. :-)
Possibly - depends on the situation. Here's a possible alternative to think about: if you describe the return from F1 independently, and then you change F2, you have to update the comment on F1 - a maintenance overhead. But if F1 always says "Returns the result of calling F2()", then it never needs updating (unless the method F1 itself changes, in which case you'd obviously have to update the comment anyway, as with any other function). If F1 is designed to be a wrapper function only (e.g., the myriad of MFC classes that more or less simply wrap GDI components), then I would suggest that what I offered is the more sensible approach; but if it is more than a simple wrapper, then I totally agree with your encapsulation comment. -- Jason Teagle [EMAIL PROTECTED] _______________________________________________ msvc mailing list [email protected] See http://beginthread.com/mailman/listinfo/msvc_beginthread.com for subscription changes, and list archive.
