Login | Register  

Coding standards for WheelMUD's source code


We are currently using StyleCop to help us keep a handle on coding standards. We haven't turned off any of the rules, so we are using the full set of rules that comes with it. There are two versions at this time:

StyleCop for Visual Studio

StyleCop for Resharper

The file headers will now look like this:

//-----------------------------------------------------------------------------
// <copyright file="Give.cs" company="WheelMUD Development Team">
//   Copyright (c) WheelMUD Development Team. See LICENSE.txt. This file is
//   subject to the Microsoft Permissive License. All other rights reserved.
// </copyright>
// <summary>
//   Created by: Karak, April 2009
//   Purpose: A command that lets a character give items to a character or a mob.
// </summary>
//-----------------------------------------------------------------------------

There's a Credits.txt file where you can add your name. I'm hoping to create a Visual Studio project template package in the near future. So that we when we create a new class we can use the template instead of what comes with Visual Studio.

Visual Studio Templates

We have created a few templates that you can install into Visual Studio.

WheelMUDGenericAction.vsi
WheelMUDGenericClass.vsi
WheelMUDGenericInterface.vsi

 These file are Visual Studio Community Content Installers. Double-click on the file, to run the installer after you download it. You may encounter this dialog:

I haven't found a way to sign these files yet. The files are just zip files, so you can look inside them with your favorite zip utility.

When you are done installing all three templates, you should see this:

Wiki Home




 | View Topic History  |
Copyright 2007-2010 by WheelMUD  | Terms Of Use | Privacy Statement
Google Analytics Alternative