名称は理解されやすく理解しやすく[C#][Web]

開発環境

・Visual Stdio 2022
・使用言語 C#
・.net framework 4.8

はじめに

コーディングRvの際にこんなことを言われたことはありませんか？
A：「このタグとかファイルの名称わかりづらくない？」
B：（え～わかりやすいと思ったのに...)
ここでBさんの作成したコードなどを見てみましょう

Bさんのコード

• ファイル名：WebPage1.aspx

    <maintitle>
        初めてのWEBサイト 
    </maintitle>
    <subtitle><br />
        僕でも簡単に組めるよ
    </subtitle>
    <br />
    <br />
    所属している人の詳細
    <asp:GridView ID="hyou" runat="server" AutoGenerateColumns="False" >
        <Columns>
            <asp:BoundField HeaderText="名前" />
            <asp:BoundField HeaderText="都道府県" />
            <asp:BoundField HeaderText="年齢" />
        </Columns>
    </asp:GridView>

どこがわかりづらいのか

まずはわかりづらいとされている箇所を箇条書きで挙げてみましょう

・ファイル名
・GridViewのID

ここがまずは違和感を感じる部分じゃないでしょうか？
(個人の主観はありますが...)

何がわかりづらいのか

ファイル名：WebPage1.aspx

ファイル名はどのような動作をするのかがはっきりとすることが求められています。
Bさんが作成したサイトはBさんが所属しているグループの名前や都道府県、年齢などの詳細情報が記載されているので、Webサイトのトップページではないことは確実でしょう。
Bさんの作成ファイルで足りないところは『所属している人間の詳細情報』です。

A：「詳細情報を表示するページなのに、『詳細情報』を示す文字が入っていないのは、わかりづらいかな」
B：「なるほど！確かに[WebPage1]だったら、Webページなことはわかりますが、それ以外のことはわからないです」
A：「訂正するとしたら、なんだろうな～。AffiliationStaffDetail.aspxとかかな」
B：「長くないですか？」
A：「...確かに」

GridViewのID：hyou

それは確かに表です。
それは表のようで表があり、表であります。
こちらもファイル名とおんなじことが言えますね。
『なんの』表なんでしょうか？っていう話になりますね。
この表に記載されている情報は何が入るのかを確認してみましょう。
今回の場合はファイル名と同様に『所属している人間の詳細情報』です。
つまり、GridViewのIDはAffiliationStaffDetailとなる。

A：「ファイル名がAffiliationStaffDetaiってなると表も同じにしても問題なさそうだな。これも長くない？」
B：「そうっすね～」
A：「何にしようかな」
B：「ですね～」

わかりやすい名称とは

結局わかりやすい名称ってなんでしょうか？
・ページの目的や表示される内容をファイル名から判断できること
・長すぎなく、短すぎない名称
上記の２点を最低限守ることが理想となっていますが、人によってこれらの理想は様々です。
少なくともいえることは、「ファイル名からそれが『何』を表示 or 動作がわかること」本当の最低条件でしょう。