はくとうのゲーム開発ライフ

UE4周りの技術メモ

Visual Studioでコードスニペットを使って効率化





はじめに


今まではコードスニペットがよくわからず(そもそも理解しようとすらしなかった), ソースコードのテンプレなどはテキストファイルにまとめていました。 テキストエディタを変えたり,テキストをいちいち開いたりと 結構手間に感じ始めたので,C++コードスニペットをつかってみることにしました。

※使用したVisualStudioは2017です。他のバージョンをご使用の方はご注意ください。





Snippetファイルを自分で作成する


snippetファイルの中身はXMLになっています。 以下は関数コメントのSnippetファイルの例になります。

 <?xml version="1.0" encoding="utf-8"?>
 <CodeSnippet Format="1.0.0">
     <Header>
         <Title>header comment</Title>
         <Shortcut>comment</Shortcut>
         <Description>ヘッダー用コメント スニペット</Description>
     </Header>
     <Snippet>
         <Code Language="CPP">
         <![CDATA[
 /**************************************************************************
  *  @brief          $selected$ $end$
  *  @param[]        
  *  @param[]        
  *  @returns        
  *  @remarks        
  **************************************************************************/
 ]]>
         </Code>
     </Snippet>
 </CodeSnippet>





スニペットファイルを追加する


VisualStudioを起動後,ツール > コードスニペットマネージャー から MyCodeSnippetsというフォルダがあるのがわかるかと思います。

このMyCodeSnippetsの下に先ほど作成したSnippetファイルを入れて, コードスニペットの追加完了です。





参考資料


VisualStudioを起動後,ツール > コードスニペットマネージャー から 各言語のSnippetファイルの場所を見ることができるので, そこに存在する.snippetを参考にしました。

各タグの意味は下記を参考にしました↓

コードスニペットスキーマリファレンス