Neat Commenting Trick With #Debug

Company | Articles & Research | Services | Software |

Our Company

All SharePoint Articles

Security

Development

Accounting / Dynamics

AIS / Dynamics GP

Other

Consulting Services

Freeware / Experiments

Applications	WebParts	Security Components
SharePoint Field Diff And Copy Utility * Written In January, 2012 SharePoint Security Scanner * Written In January, 2012 SharePoint Kerberos Buddy * Written In Feburary, 2011 BioPoint: SharePoint Biometric Authentication * Written In September, 2007 SharePoint List Security Migrator * Written In August, 2007 SharePoint Anti-Keylogger™ * Written In April, 2006 S.M.A.R.T SharePoint™ * Written In May, 2006 SharePoint Sentinel™ * Written In June, 2006 SharePoint Scrubber™ * Written In July, 2006 SharePoint Safeguard™ * Written In August, 2006	SecureSilverlight For SharePoint * Written In January, 2010 Simple Rollup WebPart For SharePoint * Written In Novemember, 2009 SimpleChart For SharePoint * Written In December, 2009 SimpleSecurity For SharePoint * Written In June, 2009 CrytoCollaboration (Encryption) * Written In June, 2007 Sample AJAX Rotator WebPart * Written In July, 2007 Sample SharePoint Redirector WebPart * Written In August, 2006 WFE Server Name WebPart * Written In January, 2006	PDF IRM Protector * Written In December, 2010 ADAM Role Provider * Written In February, 2007 Universal Provider Framework * Written In April, 2007

Contact

I wish I would have known about this trick a long time ago. Jim Sally whom I work with demonstrated to me a really neat commenting trick that I did not know about, that really helps when you are mocking out objects particularly. When you have some arbitrary class file, like this jawdropper :)

PLAIN TEXT

C#:

using System;
using Microsoft.SharePoint;
namespace examples.SharePoint.Shelter
{
public class List
{
private readonly SPWeb m_oWeb;
public List()
{
m_oWeb = null;
}
public SPWeb WebSite
{
get { return m_oWeb; }
}
public string GetListDirection(Guid oListId)
{
SPList l_oList = m_oWeb.Lists[oListId];
return l_oList.Direction;
}
}
}

There is just that string return that results in the reading direction of an arbitrary SharePoint list object, but what if you wanted to comment out that method, however because you use it for and in development, you want it AUTOMATICALLY commented out when you switch between debug (development) and release (production) build configurations, selected from the Visual Studio IDE. Jim showed me you can just wrap whatever you want with this:

PLAIN TEXT

C#:

#if (DEBUG)
#endif

So that the class file would instead look like this:

PLAIN TEXT

C#:

using System;
using Microsoft.SharePoint;
namespace examples.SharePoint.Shelter
{
public class List
{
private readonly SPWeb m_oWeb;
public List()
{
m_oWeb = null;
}
public SPWeb WebSite
{
get { return m_oWeb; }
}
#if (DEBUG)
public string GetListDirection(Guid oListId)
{
SPList l_oList = m_oWeb.Lists[oListId];
return l_oList.Direction;
}
#endif
}
}

And when you switch the build type configuration, it is automagically commented out. You can define your own, or use the ones that Visual Studio provides for you.

Article Or Research Filed Under SharePoint Development.

2 Comments »

[...] I wish I would have known about this trick a long time ago. Jim May whom I work with demonstrated to me a really neat commenting trick that I did not know about, that really helps when you are mocking out objects particularly. When you have some arbitrary Read More……(read more) September 26th 2007 Posted to Uncategorized [...]

Pingback by Blogger Loser » Neat Commenting Trick With #Debug — September 26, 2007 @ 8:54 am
Try using this site for formatting your code…

http://formatmysourcecode.blogspot.com/

Comment by Jim Sally — October 4, 2007 @ 7:11 am

RSS feed for comments on this post. TrackBack URL

Articles & Research

Latests SharePoint Development Posts

Latests SharePoint Security Posts

Neat Commenting Trick With #Debug

2 Comments »

Leave a comment