この記事は、神戸電子専門学校 ゲーム技研部 Advent Calendar 2024の6日目の記事です。
はじめに
似たようなことを人力でやるとどうしてもどこかに些細なミスが紛れ込んでしまうものです。
そういったことを極力消しつつ効率化を図った一つの例として基礎的な部分をいくつか紹介していこうと思います。
editorconfig
VisualStudioではデフォルトで保存すると文字コードがShift-JISで出力されます。
それ自体は問題ないのですが、ソフトによっては日本語部分の表示時に文字化けが出るといった不都合がよく起きていました。
そういった問題以外もまとめてコードを一貫したスタイルで編集できる神機能がeditorconfigです。
root = true
[*]
indent_style = tab
indent_size = 4
end_of_line = crlf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.{c,h,cc,hh,cpp,hpp}]
indent_size = 4
charset = utf-8-bom
# The JSON files contain newlines inconsistently
[*.json]
insert_final_newline = ignore
私はシンプル目に上記の設定でやっていましたが、大規模でソースを公開している公式リポジトリから拝借してきた方が先人の知恵が詰まっているため楽かつやりやすいかと思います。C++で言ったらEpicGamesのUnrealEngineとかおすすめです。
GitHubActions/Doxygen
Gitに上げる = 作業がある程度キリよく終わったタイミングである
その時に毎回やっている何らかの作業があるとして人力でやるの、めんどくさいと思いませんか。
一つの例ですが、多人数チーム制作をしていたらさすがにすべてを把握するなんて無理があるのでDoxygenという自動説明ドキュメント生成ツールを使用して軽く何をしているか把握できるようにしていました。その際、Gitに上げてweb経由で最新版をいつでも見れるようにしていたのですが、ドキュメントを生成するのもそれなりに時間がかかってめんどくさかったので、Gitに上げたら自動で生成してそのまま表示できるようにしました。
仕様上コメント自体のフォーマットも統一されるので一貫性を増やすという意味でもおすすめです。
Doxygenの方はまた後日別の記事で解説していく予定です。
おすすめ記事
自動スペルチェック
いつになっても撲滅することのできないスペルミス。
これも自動で監視してしまえばいいんです。
以前は拡張機能のみでしたがVisualStudioならいつの間にか公式機能になってます。(2022 17.5以降)
真ん中の方にあるabcの下に✓がついている部分を押すか(青くなっているとOn)
編集/詳細/スペルチェッカーを切り替える でOn/Offが可能です。
他の拡張機能やらなんやらでボロクソに言われてますがきちんとスペルミスを指摘してくれて
考えうる修正内容から候補リストを表示してくれたりもするので非常に便利です。
ワンボタンで出来るのでぜひともやってみてください。
最後に
いかがでしたでしょうか。
めんどくさいことなんてないに越したことはないです。
ガンガン自動化して快適開発ライフを送りましょう！！
Discussion