ASP.NETが守るべき9つのコード作成仕様
こんなに長い間プログラムコードを書いていたのに、多くの人のコードが規範的ではないことに気づいた.特に何人かが協力して一つのプロジェクトを開発しているとき、クラス名、変数名、方法などが全く読めず、プロジェクト全体を組み合わせて完成できない人もいるかもしれません.私の書いたコードはもういいと思っています.少なくとも名を見て意味を知ることができます.でも、この9つを見た後、私はもっと勉強しなければならないと思います.
1.ローカル変数の名前は意味があり、できるだけ対応する英語で命名します.例えば、「ユーザー名」変数はaabb ccなどではなく、userNameを使用します.
2.i、n、xなどの単一アルファベットの変数は使用しないでください.ではindex、tempなどを使用します.ループ反復に使用される変数の例外.
3.Pascalネーミング法を使用してメソッド名、属性名、クラス名、ネーミングスペースをネーミングする必要があります.メソッドのネーミングは一般的に◆ShowDialog()などの動賓フレーズとしてネーミングされます.◆CreateFile();◆GetPath();
4.Camelネーミング法でローカル変数とメソッドのパラメータをネーミングします.
以上のいくつかの総合例は以下の通りである.
5.ハンガリーネーミング法のみを使用してWinFormとWeb空間のネーミングを行い、textbox 1、gridview 1などのデフォルトネーミングを禁止します.
6.インタフェースの名前は、インタフェースとクラスを直感的に区別するためにINeekeなどの接頭辞として大文字と小文字Iを使用します.
7.ネーミングスペースの階層を使用して、各種類とインタフェースを整理します.
正しい:
エラー:
8.すべてのコードは十分な注釈があることを保証しなければならない.注釈量は15%以上を要求する.注釈が必要な内容は以下のとおりです.1)重要な文(重要な変数宣言、条件判断など).2)クラス名前の文書コメント(//で始まるコメント)は、クラスの簡単な機能説明、使い方などを含む.3)複雑なパラメータリストを持つ方法.
9.コードインデントはTabキーで、スペースキーは使用しないでください.
1.ローカル変数の名前は意味があり、できるだけ対応する英語で命名します.例えば、「ユーザー名」変数はaabb ccなどではなく、userNameを使用します.
2.i、n、xなどの単一アルファベットの変数は使用しないでください.ではindex、tempなどを使用します.ループ反復に使用される変数の例外.
3.Pascalネーミング法を使用してメソッド名、属性名、クラス名、ネーミングスペースをネーミングする必要があります.メソッドのネーミングは一般的に◆ShowDialog()などの動賓フレーズとしてネーミングされます.◆CreateFile();◆GetPath();
4.Camelネーミング法でローカル変数とメソッドのパラメータをネーミングします.
以上のいくつかの総合例は以下の通りである.
public class Neeke
{
public Neeke()
{
}
private string neekeName;
public string NeekeName
{
get { return neekeName; }
set { neekeName = value; }
}
public void CallMe()
{
System.Console.WriteLine("Hello Neeke!");
}
}
5.ハンガリーネーミング法のみを使用してWinFormとWeb空間のネーミングを行い、textbox 1、gridview 1などのデフォルトネーミングを禁止します.
6.インタフェースの名前は、インタフェースとクラスを直感的に区別するためにINeekeなどの接頭辞として大文字と小文字Iを使用します.
7.ネーミングスペースの階層を使用して、各種類とインタフェースを整理します.
正しい:
using Www.Ineeke.Cn;
namespace Ineeke.Cn
{
...
}
エラー:
using WwwIneekeCn;
namespace IneekeCn
{
...
}
8.すべてのコードは十分な注釈があることを保証しなければならない.注釈量は15%以上を要求する.注釈が必要な内容は以下のとおりです.1)重要な文(重要な変数宣言、条件判断など).2)クラス名前の文書コメント(//で始まるコメント)は、クラスの簡単な機能説明、使い方などを含む.3)複雑なパラメータリストを持つ方法.
9.コードインデントはTabキーで、スペースキーは使用しないでください.