TFSCCPolicy Wiki & Documentation Rss Feed

New Comment on "Screenshots"

bihe — Wed, 03 Mar 2010 15:29:25 GMT

Best namespace I've ever seen! Especially if you're from Austria.

UPDATED WIKI: Home

ChristophWille — Thu, 29 Nov 2007 10:40:59 GMT

This Team Foundation Server (TFS) checkin policy ensures that the source code contains code comments (/// for C#, ''' for VB.NET) for classes, methods, properties, fields and events before checking it into Team Foundation version control (TFVC).

History

This CodePlex project was started by Florent SANTIN, and his implementation used regular expressions for parsing. In December 2006, Christoph Wille developed a policy with the same goal using a full-blown parser engine. Both agreed to merge their efforts, and this CodePlex workspace now reflects this common effort.

Documentation, Tutorials, Blog Posts

Screenshots (shows installation and configuration options)
Installation Video

Technical background information on CCCP:

UPDATED WIKI: Screenshots

ChristophWille — Thu, 19 Jul 2007 15:12:58 GMT

Activating the policy

After installation on the developer workstations, you can activate the checkin policy in Team Explorer.

In the Source Control Settings dialog, switch to the Check-In Policy tab and click the Add button.

Select "Check for Code Comments 2.1 Policy" and click OK. This opens the policy configuration with its defaults.

Close all dialogs with OK and the checkin policy is active immediately.

Customizing the policy's behavior

By default, only public methods are checked for both C# and VB.NET. Obviously, you can add additional member types and visibility by simply selecting the respective check boxes.

Note that unchecking "Check Override Elements" means that if you are overriding eg methods from a base class, this derived class won't be checked for comments (those will be checked for the class defining the overridable method).

All the settings on the first configuration tab by default apply to the entire team project. Most often times, you want to limit checking to class library projects which are being reused and documentation in the form of help files is useful. Take this demo project:

The only project really suited for code comments is DemoClassLib. So instead of checking the entire team project, you can limit CCCP to include only certain source control directories (and its subdirectories) into the checking:

From now on, all source files from other directories are ignored and no longer checked.

Another useful feature is to exclude certain namespaces from checking. A common reason for this are namespaces that contain autogenerated code such as from Codesmith or GAT / GAX guidances.

Exclusion means "This namespace and all nested namespaces".

UPDATED WIKI: Home

ChristophWille — Thu, 19 Jul 2007 14:53:41 GMT

History

Documentation, Tutorials, Blog Posts

Screenshots (shows installation and configuration options)
Installation Video

Technical background information on CCCP:

UPDATED WIKI: Screenshots

ChristophWille — Thu, 19 Jul 2007 14:52:21 GMT

Activating the policy

Customizing the policy's behavior

By default, only public methods are checked for both C# and VB.NET. Obviously, you can add additional member types and visibility by simply selecting the respective check boxes.

Note that "Check Override Elements" means that if you are overriding eg methods from a base class, this derived class won't be checked for comments (those will be checked for the class defining the overridable method).

All the settings on the first configuration tab by default apply to the entire team project. Most often times, you want to limit checking to class library projects which are being reused and documentation in the form of help files is useful. Take this demo project:

The only project really suited for code comments is DemoClassLib. So instead of checking the entire team project, you can limit CCCP to include only certain source control directories (and its subdirectories) into the checking:

From now on, all source files from other directories are ignored and no longer checked.

Another useful feature is to exclude certain namespaces from checking. A common reason for this are namespaces that contain autogenerated code such as from Codesmith or GAT / GAX guidances.

Exclusion means "This namespace and all nested namespaces".

UPDATED WIKI: Screenshots

ChristophWille — Thu, 19 Jul 2007 14:51:08 GMT

Activating the policy

Customizing the policy's behavior

By default, only public methods are checked for both C# and VB.NET. Obviously, you can add additional member types and visibility by simply selecting the respective check boxes.

Note that "Check Override Elements" means that if you are overriding eg methods from a base class, this derived class won't be checked for comments (those will be checked for the class defining the overridable method).

All the settings on the first configuration tab by default apply to the entire team project. Most often times, you want to limit checking to class library projects which are being reused and documentation is form of help files is useful. Take this demo project:

The only project really suited for code comments is DemoClassLib. So instead of checking the entire team project, you can limit CCCP to include only certain source control directories (and its subdirectories) into the checking:

From now on, all source files from other directories are ignored and no longer checked.

Another useful feature is to exclude certain namespaces from checking. A common reason for this are namespaces that contain autogenerated code such as from Codesmith or GAT / GAX guidances.

Exclusion means "This namespace and all nested namespaces".

UPDATED WIKI: Screenshots

ChristophWille — Thu, 19 Jul 2007 14:36:50 GMT

Activating the policy

After installation on the developer workstations, you can activate the checkin policy in Team Explorer.

Click on Add.

Select "Check for Code Comments 2.1 Policy" and click OK. This opens the policy configuration with its defaults.

Close all dialogs with OK and the checkin policy is active.

Customizing the policy's behavior

UPDATED WIKI: Screenshots

ChristophWille — Thu, 19 Jul 2007 14:31:39 GMT

Activating the policy

After installation on the developer workstations, you can activate the checkin policy in Team Explorer.

UPDATED WIKI: Home

ChristophWille — Thu, 19 Jul 2007 14:29:09 GMT

History

Documentation, Tutorials, Blog Posts

Technical background information on CCCP:

UPDATED WIKI: Home

ChristophWille — Thu, 19 Jul 2007 14:19:15 GMT

History

Documentation, Tutorials, Blog Posts

Installation Video

Technical background information on CCCP:

UPDATED WIKI: Home

ChristophWille — Wed, 24 Jan 2007 10:22:08 GMT

History

Documentation, Tutorials, Blog Posts

Installation Video

Technical background information on CCCP:

UPDATED WIKI: Home

ChristophWille — Sun, 21 Jan 2007 10:42:18 GMT

History

Documentation, Tutorials, Blog Posts

Installation Video

Technical background information on CCCP:

UPDATED WIKI: Home

ChristophWille — Sun, 21 Jan 2007 10:41:45 GMT

Project Vision

History

Documentation, Tutorials, Blog Posts

Installation Video

Technical background information on CCCP:

UPDATED WIKI: Home

ChristophWille — Sun, 21 Jan 2007 10:39:07 GMT

Project Vision

This Team Foundation Server policy ensures that the code contains comments for classes,
methods and properties before checking in it to the source control server.

History

Documentation, Tutorials, Blog Posts

Installation Video

UPDATED WIKI: Home

fsantin — Fri, 22 Sep 2006 21:06:06 GMT

This Team Foundation Server policy ensures that the code contains comments for classes, methods and properties before checking in it to the source control server.

To use it needs to be installed on each development computer.
When done:
- Launch Team Explorer
- Connect to your Team Foundation Server
- Select your Team Project
- Use the right click to select Team Project Setting then Source Control
- In the Check-in policy Tab, click on add then select "code comments check-in policy"

{FRENCH} Vous pouvez trouver un article en Français concernant la création de politique de Check-in sur le site MSDN http://www.microsoft.com/france/msdn/vstudio/centrescompetences/winwise/checkinTFS.mspx {/FRENCH}

Florent SANTIN
http://blogs.developpeur.org/azra
http://www.winwise.com

UPDATED WIKI: Home

fsantin — Fri, 22 Sep 2006 21:05:30 GMT

This Team Foundation Server policy ensures that the code contains comments for classes, methods and properties before checking in it to the source control server.

FRENCH Vous pouvez trouver un article en Français concernant la création de politique de Check-in sur le site MSDN http://www.microsoft.com/france/msdn/vstudio/centrescompetences/winwise/checkinTFS.mspx /FRENCH

Florent SANTIN
http://blogs.developpeur.org/azra
http://www.winwise.com

CREATED WIKI: /FRENCH

fsantin — Fri, 22 Sep 2006 21:05:30 GMT

CREATED WIKI: FRENCH

fsantin — Fri, 22 Sep 2006 21:05:30 GMT

UPDATED WIKI: Home

fsantin — Fri, 22 Sep 2006 20:55:51 GMT

This Team Foundation Server policy ensures that the code contains comments for classes, methods and properties before checking in it to the source control server.

Florent SANTIN
http://blogs.developpeur.org/azra
http://www.winwise.com

UPDATED WIKI: Home

fsantin — Fri, 22 Sep 2006 20:51:30 GMT

This Team Foundation Server policy ensures that the code contains comments for classes, methods and properties before checking in it to the source control server.