Documentation and Copyright Info
-
Hi All, This question is might asked so many times but after searching hours and hours on google and koders (and some other site also), I did not found a solution. The company I am working in, is very small and we are not following any guidelines for documentation. From this month we developers have decided to give a shot to follow some documentation guidelines, so other developers can undestand the code in order to accomplish the task in time. Currently, we dont add have documentation guidelines or we dont add code comments. It would be great if we can help for documentation in code like comments and copyright info, review date, revision etc.... One more thing I wasn't talking about .... Thanks Micky
-
Hi All, This question is might asked so many times but after searching hours and hours on google and koders (and some other site also), I did not found a solution. The company I am working in, is very small and we are not following any guidelines for documentation. From this month we developers have decided to give a shot to follow some documentation guidelines, so other developers can undestand the code in order to accomplish the task in time. Currently, we dont add have documentation guidelines or we dont add code comments. It would be great if we can help for documentation in code like comments and copyright info, review date, revision etc.... One more thing I wasn't talking about .... Thanks Micky
It's not entirely clear what you are asking. If you are looking for code standards/guidelines you can check out the Framework Design Guidelines[^] book. An online version is also available here[^]. These are specifically focused on .NET code, but a lot of the guidelines apply to other languages as well. You should also check out the following tools (also for .NET only): FxCop[^] StyleCop[^]
Scott Dorman
Microsoft® MVP - Visual C# | MCPD President - Tampa Bay IASA [Blog][Articles][Forum Guidelines]
Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai