TFS Code Comment Checking Policy (CCCP)

New Post: suggestion - specific format of the comments

jbmixed — Wed, 11 Jun 2008 16:17:34 GMT

Hi, the tool is great, but I have a suggestion to take it to the next level :)

It could be great to force the developer to add the comments in a specific format before allow him to check in, for example:

This whould be correct:

/// <summary></summary>
/// <author></author>
/// <date></date>
public class Customer

This whould be INcorrect:

/// I don't respect the comments rules! :P
public class Customer

Thanks

NEW POST: Does this work with TFS 2008?

niksac — Mon, 26 May 2008 07:37:55 GMT

Hi

I installed this but I do not see the policies coming in Team Explorer for VSTS 2008.
was wondering is this works with 2008?

Thanks
Nik

NEW POST: Only modified code is checked

ChristophWille — Thu, 03 Apr 2008 12:36:30 GMT

This discussion has been copied to a work item. Click here to go to the work item and continue the discussion.

CREATED ISSUE: Only modified code is checked

ChristophWille — Thu, 03 Apr 2008 12:36:28 GMT

Hi,

it would be nice if CCCP would not only check modified code but also already existing code.

Alex

NEW POST: Only modified code is checked

AlexOnASPDotNET — Sat, 23 Feb 2008 22:22:27 GMT

Hi,

it would be nice if CCCP would not only check modified code but also already existing code.

Alex

NEW POST: Plug-Ins

Scordo — Tue, 12 Feb 2008 15:12:27 GMT

^^ double post - sorry

NEW POST: Plug-Ins

Scordo — Tue, 12 Feb 2008 15:12:27 GMT

Hi,

I'm also looking for a documentation. I want to create a plugin which checks the parameters of a method for emptiness.
So I put a test-class in a dll, which I strongly signed and put that dll into GAC:

CheckCodeCommentsPlugin("CheckForEmptyCommentBody", "Checks if method-parameter-documentation is not empty.")
public class CheckForEmptyCommentBody : ICheckCodeCommentsPlugin
{
private ICheckCodeCommentsHost _objHost;

#region ICheckCodeCommentsPlugin Members

public void BeginCompilationUnitVerification(string sourceCode, IParser parser, NRefactoryASTConvertVisitor visitor)
{

}

public void EndCompilationUnitVerification()
{

}

public void Initialize(ICheckCodeCommentsHost host)
{
_objHost = host;
}

public CheckCodeCommentsVerificationState VerifyClass(IClass c)
{
return CheckCodeCommentsVerificationState.Pass;
}

public CheckCodeCommentsVerificationState VerifyEvent(IEvent e)
{
return CheckCodeCommentsVerificationState.Pass;
}

public CheckCodeCommentsVerificationState VerifyField(IField f)
{
return CheckCodeCommentsVerificationState.Pass;
}

public CheckCodeCommentsVerificationState VerifyProperty(IProperty p)
{
return CheckCodeCommentsVerificationState.Pass;
}

public CheckCodeCommentsVerificationState VerifyMethod(IMethod m)
{
_objHost.ReportError("Params found: " + ToCommaSeperatedString(m.Parameters));
_objHost.ReportError("Comment: " + m.Documentation);

return CheckCodeCommentsVerificationState.Pass;
}

#endregion

private static string ToCommaSeperatedString(IList<IParameter> objParameters)
{
StringBuilder objResult = new StringBuilder();

foreach (IParameter objParameter in objParameters)
{
objResult.Append(objParameter.Name + ", ");
}

return objResult.ToString().TrimEnd().TrimEnd(',');
}
}

When I now select my Assembly in the AssemblyList and press "ok" the Plugin is not listet in the Plugins-Listbox.
When I choose another DLL a messagebox states, that there is no valid Plugin in it.

Is the plugin-feature buggy or not fully implemented, or am I doing somethign wrong??

NEW POST: Plug-Ins

AlexOnASPDotNET — Wed, 06 Feb 2008 16:27:21 GMT

Hi,

whats the state of the plug-in model implemented in CCCP?
Is there a sample for a custom plug-in?

Alex

NEW POST: No code comment for ..... at line 0

AlexOnASPDotNET — Wed, 06 Feb 2008 16:18:19 GMT

Hi,

when having fields check enabled and no comment provided on a field, I get a warning like this:

No code comment for myfield in class myclass at line 0 also the affected code e.g. resides in line 20.

Alex

NEW POST: Jump into affected code

AlexOnASPDotNET — Wed, 06 Feb 2008 15:53:13 GMT

Hi,

if CCCP has not been satisfied by my code on check-in, it would be nice if I could double click the Policy Warnings and jump directly into the affected line(s) of code.

Is it possible to implement this?

Alex

COMMENTED ISSUE: Eliminate dependency DLLs in GAC

ChristophWille — Thu, 29 Nov 2007 13:28:14 GMT

We have a batch file & exe combination which automatically creates a workspace to our CommonCode folder, gets all the custom check-in policies, and then calls the exe which adds the registry entry for each dll in the folder into the registry.

This works fine with other custom check-in policies, but not for this one. This is because the CCCPPol.dll depends on CCCPLib & NRefactory components and requires them installed in the GAC. Can something be done about this to support the deployment model above?
Comments: ** Comment from web user: ChristophWille **

Problem is, when the policy is loaded, it won't be able to load assemblies that live next to it in the same folder (at least for VSTS2005 this was the case, and that's why those three assemblies are installed in the GAC).

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:

CREATED RELEASE: CCCP 3 Beta 1 (VSTS 2008 Compatible) (Nov 29, 2007)

Thu, 29 Nov 2007 10:37:08 GMT

This release targets Visual Studio 2008 RTM ("Visual Studio 9"). If you want to use this checkin policy with Visual Studio 2005, please download version 2.2.1 which is designed to work with VSTS 2005. Note that 2.2.1 doesn't work with VS08, and version 3 not with VS05!

Source code checked in

ChristophWille — Thu, 29 Nov 2007 10:32:09 GMT

Setup v3 Beta 1

Source code checked in

ChristophWille — Thu, 29 Nov 2007 10:28:33 GMT

Switched all projects to target .NET Framework 3.5, changed version number to 3.0.0.1 to distinguish from earlier Orcas builds

Source code checked in

ChristophWille — Thu, 29 Nov 2007 10:22:41 GMT

Sample updated for current build

Source code checked in

ChristophWille — Thu, 29 Nov 2007 10:19:11 GMT

Parser assemblies updated to 3.0.0.2751

CREATED ISSUE: Class comment not found if attributes in regiones

sockenfresser — Fri, 09 Nov 2007 09:28:18 GMT

The class comment is not found if the class attributes are contained in a "#region".

This sometimes is necessary to hide the attributes, if you have a lot of them.

Try this example:

using System;
using System.Collections.Generic;
using System.Text;

namespace Hermos.ESystem.V3.Modules.Customer
{
/// <summary>
/// Do you know what CCCP means in Cyrillic?
/// </summary>
#region a lot of Attribute stuff
[Serializable()] //
#endregion
public class CCCPTest
{

}
}

CREATED ISSUE: Eliminate dependency DLLs in GAC

Chandalar — Wed, 24 Oct 2007 21:08:06 GMT

NEW POST: Orcas Compatibility

HHuxel — Thu, 09 Aug 2007 15:37:35 GMT

Wow. A very quick release. I test it. Thanks