Difference between revisions of "ApCoCoALib:CodingGuidelines"

From ApCoCoAWiki
m (→‎GPL notice: Stubs -> Stub)
(added section for namespace rules.)
Line 28: Line 28:
 
  // along with ApCoCoA; if not, write to the Free Software
 
  // along with ApCoCoA; if not, write to the Free Software
 
  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 +
 +
==Namespace issues==
 +
Do not "use" for any namespaces, including std or CoCoA.
 +
Include your code into the following namespace structure:
 +
 +
namespace ApCoCoA{
 +
  namespace AlgebraicCore{}
 +
  namespace NumericCore{}
 +
  namespace AlgebraicAlgorithms{}
 +
  namespace NumericAlgorithms{}
 +
  namespace HybridAlgorithms{}
 +
}
  
 
{{Stub}}
 
{{Stub}}
  
 
[[Category:ApCoCoA]]
 
[[Category:ApCoCoA]]

Revision as of 17:28, 7 June 2007

General Rules

Please follow the CoCoALib coding standards unless noted otherwise.

GPL notice

Please use the following GPL notice for all your files:

// This file is part of the source of ApCoCoALib, the ApCoCoA Library.
//
// Copyright YEAR[S], NAME[S] OF COPYRIGHT HOLDERS
//
// visit http://apcocoa.org/ for more information regarding ApCoCoA
// and ApCoCoALib.
// visit http://www.apcocoa.org/wiki/ApCoCoA:KnownIssues for bugs, problems 
// and known issues.
//
// ApCoCoALib is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License (version 2)
// as published by the Free Software Foundation. A copy of the full
// licence may be found in the file COPYING in this directory.
//
// ApCoCoALib is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ApCoCoA; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Namespace issues

Do not "use" for any namespaces, including std or CoCoA. Include your code into the following namespace structure:

namespace ApCoCoA{
 namespace AlgebraicCore{}
 namespace NumericCore{}
 namespace AlgebraicAlgorithms{}
 namespace NumericAlgorithms{}
 namespace HybridAlgorithms{}
}

This article is a stub. You can make this wiki more useful by adding information.