|
Stormwind Project enforces certain standards among its projects. The reasoning behind this is to lower the entry barrier for new people in the codebase. So in order for a project to be included in the codebase it has to follow some rules detailed in this document. There are to be no exceptions to these rules, unless the rule is marked as optional. Licensing The licensing to be used in all projects in Stormwind is Open Software License ("OSL") v. 3.0 and the following header will be required in every single .cs file in every project: // Copyright 2006-2007 Stormwind Project - http://www.stormwindproject.org/ // // Licensed under the Open Software License ("OSL") v. 3.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.opensource.org/licenses/osl-3.0.php // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License.
To learn more about the licensing model of Stormwind Project, click in Licensing in the left menu. Coding Conventions Every C# file in the Stormwind Project must have XML Comments in every public method. A sample C# file would be: // Copyright 2006-2007 Stormwind Project - http://www.stormwindproject.org/ // // Licensed under the Open Software License ("OSL") v. 3.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.opensource.org/licenses/osl-3.0.php // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. namespace Stormwind.SampleProjectName { using System; using System.Collections.Generic; using System.Text;
/// <summary> /// Class comment sample. /// </summary> public class Sample { #region [rgn] Methods (3)
// [rgn] Public Methods (1)
/// <summary> /// Executes the sample. /// </summary> public void Execute() { } // [rgn] Protected Methods (2)
/// <summary> /// Some protected method. /// </summary> protected void Method1(){
} /// <summary> /// Another protected method. /// </summary> protected void Up(){
} #endregion [rgn]
} }
|