Today while browsing I came across Matthew M. Osborn's Blog and I found this fantastic line: “Documentation is the coders best and worst friend. It is a two sided sword, it makes your life easier but no one likes writing it. So coders do what we do best and find a way to make the computer do it for us.”
Today while browsing I came across Matthew M. Osborn’s Blog and I found this fantastic line
“Documentation is the coders best and worst friend. It is a two sided sword, it makes your life easier but no one likes writing it. So coders do what we do best and find a way to make the computer do it for us.”
Ideally I use GhostDoc to make comments for my codes and really it works fine for me. From the very first day since I have been using this, I always thought whether I can change the xml documentation as per my need or not.
Today I have found a simple trick to add to custom node to the xml commenting.
Here was my scenario,
All my method/class/event level comment must include author name along with the time when it was written.
For this I need to add the following lines in the Ghost Doc > Options > Custom Texts
<author>$(Environment.UserName)</author>
<datetime>$(Environment.Date)-$(Environment.Time)</datetime>
And the ghost doc generated comment contains author and datetime tag!!!
private static User GetUserByID(long ID)
{
User user = new User();
return user;
}
I am truly versatile and 360 degree Engineer having wide range of development experience in .NET and Java Platform. I am also proficient in system level programming in C++. To me technology is not at all a problem, it’s the client requirement that matters! That is I am ready and comfortable to use any technology to make the business of my client a success.
In my five years of experience I have the opportunities to work for fortune 500 companies of US and many renowned clients from Europe.
My Linkedin Profile: http://bd.linkedin.com/in/mahmudazad