CodingConvention

9. コーディング規約

プログラムを開発する上で、ソースコードの一貫性を保つことは、可読性が増しバグの少ないコーディングに役立ちます。また、ソースコードの拡張性や保守性を高めることができます。ここでは、KVS内部で採用されているコーディング規約についてまとめます。

以下では、KVSのコーディング規約をスタイル規約、命名規約、プログラミング規約、ドキュメント規約の4つに分類して説明します。

• スタイル規約
• 命名規約
• プログラミング規約
• ドキュメント規約

1. 現在のKVSソースコード内では、ある一定の規則のもとでコーディングされていますが、いくつかの部分で曖昧な部分があり、冗長な記述が見られます。ここに規約として明示することで、今後、一貫したスタイルでコーディングをすすめていく予定です。
2. 本規約は、KVS内のコーディング規約を網羅するものではありません。本規約に書かれていない暗黙的な規則等については、原則として、オリジナルのスタイルを崩すこと無くそれに従うこととします。しかし、拡張性や保守性を損なう規則については、規定を明示し、今後必要に応じて改定していく予定です。