WEB開発におけるコーディング規約の意味

date_range 2024/06/05
池田 駿
スパゲッティコード

こんにちは、

WEBプログラマーコースの池田駿です。

今日から研修の一環でWEBプロダクト隊パーツ班でパーツを作成することになりました。

初日からガッツリWEB開発かな...と思っていたら、まずはコーディングルールを読め、とのことで

PDF30枚以上にわたるルールを読みました。

正直すべて覚えるのにはかなり時間がかかりそうですが、

理にかなったものばかりなので「覚える」というよりは「感覚に慣れる」

という感じだと思っています。

具体的な内容を少しご紹介します。

・ウィジェット内クラスのクラス名は"w-○○"にする

・文字サイズはemまたは%で指定

・特定のパーツは絶対ほかのパーツから呼び出す(単独使用禁止)

など、大人数でWEB開発をするにあたっての共通認識が書かれていました。

WEB開発では論理的な齟齬以外にも「見た目の崩れ」があります。

そしてその見た目というのはローカルの環境だけでは確認しきれない部分が大きいので

あらかじめノウハウを共有してもらえることは非常にありがたいです。

私も大学の授業でチーム開発を行ったことがありますが、ルールを決めないと

色々な問題が起こります。例えば

・ファイル同士の相互参照

・while(true)ループの点在

・メソッド名の不整合

・引数の型違い

まあとにかく惨憺たるプログラムが出来上がります(笑)

これからWEB開発に限らず様々な開発、研究活動を集団で行うと思うので、

開発手法の勉強でもあると思ってWEBプロダクト隊での仕事を頑張って行きたいと思います。

*COMMENT*

  • 下川 春樹

    下川 春樹

    更新日:2024-06-05 20:07

    *コメント*

    お疲れ様です。
    コーディングルール大切ですよね。
    うちの部ではクラス名の接頭は、-w-です。同じ認識だったのですが、違いましたか??
    どんどん色んなパーツを作って理解を深めていきましょー٩( 'ω' )و

    *コメント*

  • 石川 航

    石川 航

    更新日:2024-06-05 23:09

    *コメント*

    お疲れ様です
    コーディング規約は、複数人でWebサイトを作っていくには必ず必要になるものです

    特にOWLetではパーツ・ウィジェット単位で運用されていくので、
    全員が規約を守っていないとごちゃごちゃした構成になったり、
    CSSやJavascriptが予想外の場所にも適用されてしまうなどトラブルの原因になります

    コーディング規約が作られるのは、ちゃんとした理由があるので、
    しっかり内容を理解していこう

    *コメント*

  • 水落 えり

    水落 えり

    更新日:2024-06-06 08:32

    *コメント*

    駿くん、WEBプロダクト隊パーツ班でパーツを作成できることになったんだね✨おめでとう!!

    コーディングルールの30ページ超えそれはすべて覚えるのには時間がかかりそうですね!!
    「覚える」のではなく「感覚に慣れる」というスタンスで取り組まれていければ覚えも早くなりますね✨
    大規模プロジェクトではルールを共有し、統一した開発スタイルを心がけることが何より重要になりますね。見た目の維持という点でも、お互いにノウハウを持ち寄ることができるメリットは大きいはずですね。

    今回の研修においてしっかりとコーディングルールを身に付けようという意識を持たれているのは素晴らしいことです。
    頑張ってくださいね!

    *コメント*

  • 菅谷 たかの

    菅谷 たかの

    更新日:2024-06-06 12:43

    *コメント*

    コーディングルールというのはなんとなく知っていましたが、PDF30ぺージというのは凄い量でびっくりしました。少しでも認識のズレがあると、すぐに不具合が生じますね。私もルールについて調べてみます!

    *コメント*

  • 菅谷 たかの

    菅谷 たかの

    更新日:2024-06-06 12:45

    *コメント*

    30ページもあるとはびっくりしました。確かに認識のズレが、すぐに不具合につなげってしまうので、気を付けないといけないところですね。私もコーディングのルールについて確認しようと思います。

    *コメント*

  • 奥村 優

    奥村 優

    更新日:2024-06-06 17:14

    *コメント*

    お疲れ様です。
    チームでしていくのにコーディング規約はとても大事ですよね。自分も前社でありましたが、覚えるのが大変だった記憶があります。会社によってルールが本当に変わるので覚えるのが大変だと思いますが、頑張ってください!

    *コメント*

*コメント*

*ログイン*

メールアドレス
パスワード