Q&A
今のコード公開してアドバイス求めれば無償でコードレビューしてくれる人がそれなりに出てくると思いますよ
当方、初心者が集まったグループでWEBページの制作を行っております。
動的ページを作成しているのですが、最近JavaScriptのコードが難読になってきていたり、バグが出やすくなったと感じます。
課題としては、
- 何がどこに書いているかわからない
- htmlとの対応がわからなくなる
- 拾っているイベントが管理できてない
が挙げられました。
この課題に対して、
みなさんが為されている対策や工夫や
参考になりそうな資料やサンプルコードがあれば教えていただけないでしょうか？
特に解決したいわけではなく興味本位だけだったと。
なぜ退会したのか・・・
回答2件
0
- 何がどこに書いているかわからない
できるだけコメントを残すようにしています。
ファイルサイズが気になるのであればjsファイルの圧縮等のツールで小さくできます。
- htmlとの対応がわからなくなる
これもコメントを残すようにしています。
あとビジネスロジックと共通的な処理はファイルを分けるなどしています。
クラス単位でわけるのも有効かと思います。
- 拾っているイベントが管理できてない
処理を分ける事ができれば、おのずと管理しているイベントも整理されます。
他の方も書かれていますが、ファイルの先頭に変更履歴を記載しておくとバージョン管理が楽です。
コメントの書き方は極端な例ですが形式を決めておけば抽出してドキュメント化できます。
コメントパーサを利用した簡単なAPIドキュメンテーション方法
あとJavaScriptではあまり見かけませんが変数名に接頭語をつけたりしています。
JavaScript
1// 例 2var sText = ''; // 文字列を格納する場合 3var nNumber = 0; // 数値を格納する場合 4var oObject; // オブジェクトを格納する場合 5var elElement; // エレメントを格納する場合
意外とデバックが楽だったりします。
それ以外だと、できるだけロジックはシンプルにする。
例えば「ランダムな数値を取得する」には
乱択アルゴリズムを応用したほうがより平均的なランダム数になりますが
Math.random()を使ったほうがシンプルです。
できるだけ後から見て(他人が見ても)内容が理解できれば良いですが
できるだけメインはシンプル(単純)に書いてそれ以外は共通部品とする事(1度しか使わなくても)を
オススメします。
投稿2020/09/16 05:04
総合スコア2506
JavaScriptでハンガリアン記法を勧めている人を初めて見たのですが、JavaScriptでハンガリアン記法が有効という資料や記事など補足するものが何かありますでしょうか？ハンガリアン記法自体が批判が多いですが、それでもJavaScriptで勧めている理由があれば教えてください。
raccyさん
いいえ資料などはないです。
ただ自分が判りやすかったから書いたまでです。(経験談)
例えるなら変数を見た時に数字or数値どちらかすぐに判り誤りも判断できるとかでしょうか？
あと変数の命名規約が作りやすいとかでしょうか？
手馴れてない頃ほど重宝しました。
> あとJavaScriptではあまり見かけませんが
一応積極的なオススメとしていないのですが．．．
サンプルの命名について
> 接頭語
ではなく接尾辞ではないでしょうか？
確認してみました
接尾辞とは、接辞のうち、語基の後ろに付くもの。
接頭辞、プレフィックスとは、接辞のうち、語基よりも前に付くもの。
今回は変数の名称(語基)前につけるのお話なので問題ないかと思います。
いえ、「変数名」に「接尾」で「Number」や「Text」を付けていますよね？
あ、意味がわかりました。「s」や「n」が型名で、「Text」「Number」が変数名だったんですね。
例を「sName」や「nAge」のようにした方がわかりやすいかと思いました。
あなたの回答
tips
プレビュー
