Jasinski_VHDL_Coding_Style_Guidelines.pdf, R83
非公式訳
R84 データオブジェクト(変数、信号、定数、ジェネリック)に名前をつけるときは、そのオブジェクトに何が保持されるのかが名前から分かるようにせよ
たとえばINPUT_BITS
という名前があるとします。作成者本人にしてみれば、入力ポートのビット数を保持するオブジェクトであることを明確に示す完璧な名前のつもりかもしれません。しかしこの名前が示しているのはそういう内容ではありません。この名前が示しているのは、ビット列を保持するオブジェクトであるということです。混乱を避けるためには常に明確であることを心がけてください。要素の数を数えるオブジェクトであるなら、その名前にはNUMBER
、NUM
、COUNT
のいずれかを入れてください。排列の要素数、次元数を指定するオブジェクトの名前には、SIZE
、LENGTH
、LEN
のいずれかを入れてください。