System-wide compiler symbols

PIEBALDconsult

Rate me:

3.88/5 (7 votes)

11 Jul 2010CPOL1 min read

17.4K

A way to define system-wide compiler symbols to be used for all C# builds

On occasion, when writing code that should compile cleanly with various versions of .net, we run into situations where we need to use conditional compilation.

There are two often-used methods to define symbols for this:
0) Put a #define within the code we are working on.
1) Create a project-wide symbol (via project properties).

However, I feel a more general, system-wide, solution is required. With C and C++ there are various built-in symbols to indicate such things; C# currently has no such built-in symbols.

This tip describes my current method of defining a compiler symbol that indicates which version of .net is in use by the compiler.

The various versions of .net reside in the
%windir%\microsoft.net\framework directory; each version has its own subtree.

The files we want to edit are:
CSC.RSP -- which is used when command-line compiling with CSC (the C# compiler)
Microsoft.CSharp.targets -- which is used by MSBUILD (and therefore Visual Studio) when compiling C# code

In each CSC.RSP, add a line like /d:DotNet_4_0. You may choose your symbol, but it should be descriptive.

In each Microsoft.CSharp.targets, change
DefineConstants="$(DefineConstants)"
to
DefineConstants="$(DefineConstants) DotNet_4_0"
(or whatever symbol you chose, but it should match what you added to the CSC.RSP file).

You will need to do this on each development system. And it will need to be done as new versions of .net become available.

Thereafter, whenever you compile C# code, the appropriate symbol should exist, and you can use compiler directives (#if) to determine the .net version.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Written By

PIEBALDconsult

Software Developer (Senior)

United States

BSCS 1992 Wentworth Institute of Technology

Originally from the Boston (MA) area. Lived in SoCal for a while. Now in the Phoenix (AZ) area.

OpenVMS enthusiast, ISO 8601 evangelist, photographer, opinionated SOB, acknowledged pedant and contrarian

---------------

"I would be looking for better tekkies, too. Yours are broken." -- Paul Pedant

"Using fewer technologies is better than using more." -- Rico Mariani

"Good code is its own best documentation. As you’re about to add a comment, ask yourself, ‘How can I improve the code so that this comment isn’t needed?’" -- Steve McConnell

"Every time you write a comment, you should grimace and feel the failure of your ability of expression." -- Unknown

"If you need help knowing what to think, let me know and I'll tell you." -- Jeffrey Snover [MSFT]

"Typing is no substitute for thinking." -- R.W. Hamming

"I find it appalling that you can become a programmer with less training than it takes to become a plumber." -- Bjarne Stroustrup

ZagNut’s Law: Arrogance is inversely proportional to ability.

"Well blow me sideways with a plastic marionette. I've just learned something new - and if I could award you a 100 for that post I would. Way to go you keyboard lovegod you." -- Pete O'Hanlon

"linq'ish" sounds like "inept" in German -- Andreas Gieriet

"Things would be different if I ran the zoo." -- Dr. Seuss

"Wrong is evil, and it must be defeated." –- Jeff Ello

"A good designer must rely on experience, on precise, logical thinking, and on pedantic exactness." -- Nigel Shaw

“It’s always easier to do it the hard way.” -- Blackhart

“If Unix wasn’t so bad that you can’t give it away, Bill Gates would never have succeeded in selling Windows.” -- Blackhart

"Use vertical and horizontal whitespace generously. Generally, all binary operators except '.' and '->' should be separated from their operands by blanks."

"Omit needless local variables." -- Strunk... had he taught programming

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

System-wide compiler symbols

License

Comments and Discussions