Informative Comments
-
So, I'm looking at the code for one our apps, and all of the source files start with comments like:
//---------------------------------------- // XYZBase.h // // This is the header file that declares class CXYZBase. ////---------------------------------------- // XYZBase.cpp // // This file contains the implementation of class CXYZBase. //OK, thanks for telling me that you've been following our file-naming convention. But what does the class do? -
So, I'm looking at the code for one our apps, and all of the source files start with comments like:
//---------------------------------------- // XYZBase.h // // This is the header file that declares class CXYZBase. ////---------------------------------------- // XYZBase.cpp // // This file contains the implementation of class CXYZBase. //OK, thanks for telling me that you've been following our file-naming convention. But what does the class do?What about an automated tool that deletes all code having less than 10% of comments in? :-D
If the Lord God Almighty had consulted me before embarking upon the Creation, I would have recommended something simpler. -- Alfonso the Wise, 13th Century King of Castile.
[my articles] -
So, I'm looking at the code for one our apps, and all of the source files start with comments like:
//---------------------------------------- // XYZBase.h // // This is the header file that declares class CXYZBase. ////---------------------------------------- // XYZBase.cpp // // This file contains the implementation of class CXYZBase. //OK, thanks for telling me that you've been following our file-naming convention. But what does the class do?what about an automated routine that deletes all code from incompentant programmers ;-)
-
what about an automated routine that deletes all code from incompentant programmers ;-)
Gimme back my code!!!!!!!!!!!!!!!!! :laugh:
If the Lord God Almighty had consulted me before embarking upon the Creation, I would have recommended something simpler. -- Alfonso the Wise, 13th Century King of Castile.
[my articles] -
So, I'm looking at the code for one our apps, and all of the source files start with comments like:
//---------------------------------------- // XYZBase.h // // This is the header file that declares class CXYZBase. ////---------------------------------------- // XYZBase.cpp // // This file contains the implementation of class CXYZBase. //OK, thanks for telling me that you've been following our file-naming convention. But what does the class do?This is very probably a template for new source files which was never changed. For what the class does - Use the code, Luke! ;P
Let's think the unthinkable, let's do the undoable, let's prepare to grapple with the ineffable itself, and see if we may not eff it after all.
Douglas Adams, "Dirk Gently's Holistic Detective Agency" -
This is very probably a template for new source files which was never changed. For what the class does - Use the code, Luke! ;P
Let's think the unthinkable, let's do the undoable, let's prepare to grapple with the ineffable itself, and see if we may not eff it after all.
Douglas Adams, "Dirk Gently's Holistic Detective Agency"jhwurmbach wrote:
For what the class does - Use the code, Luke!
Well, yeah. But such headers requires the reader having to scroll more, thus adding to the wear and tear on his/her finger joints. That is bad, and might result in a shortened life span as a programmer. ;)
-- Kein Mitleid Für Die Mehrheit
-
What about an automated tool that deletes all code having less than 10% of comments in? :-D
If the Lord God Almighty had consulted me before embarking upon the Creation, I would have recommended something simpler. -- Alfonso the Wise, 13th Century King of Castile.
[my articles]Won't do. You can easily meet the 10% quota by writing things like:
//----------------------------------------
// CFoo::LogMessage
//
// Log a message.
//
// Args:
// strMsg = the message to log
//
// Returns:
// void
//
void CFoo::LogMessage(const CString& strMsg) -
jhwurmbach wrote:
For what the class does - Use the code, Luke!
Well, yeah. But such headers requires the reader having to scroll more, thus adding to the wear and tear on his/her finger joints. That is bad, and might result in a shortened life span as a programmer. ;)
-- Kein Mitleid Für Die Mehrheit
What? You mean you don't have the audio/visual integration tool based on the Apache weapons officer helmet that tracks your eye movement and interprets you verbal commands? Man, life became much easier when I put on the helmet. I can't wait until they finish getting the jack put in my cerebelum so I can just think code. ;P