はじめに
初めての方ははじめまして,そうでない方はお久しぶりです!RiRyです!
学生終わりぐらいからQiitaで記事をかけていなかったのですが,最近また記事を書きたくなり戻ってきたところ,色々とできることが増えていました!
なので,Qiitaのコマンド補完機能について紹介させていただきいます!
Qiitaで最近記事を書き始めた人向けの記事になりますのでご注意ください.
コマンド補完機能について
2023年10月30日にQiitaのアップデートがあったようで,Qiitaのエディタ上で「/」を入力すると次のようなリストが表示されます.
これをコマンド補完機能と呼びます.
codeblock
以下のようなものをcodeblockと呼び,コードを記述するフィールドを補完できます.
ここにコードを入力します
コマンド補完機能を使用してコードブロックを挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「codeblock」を選択します)
/codeblock
codeblock の例
def greeting(name: str) -> str:
print(f'Hello, {name}!')
greeting('RiRy') # Hello, RiRy!
greeting('Casals') # Hello, Casals!
alert
以下のようなものをalertと呼び,警告説明文を記述するフィールドを補完できます.
これが警告説明文です
コマンド補完機能を使用して警告説明文を挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「alert」を選択します)
/alert
alert の例
def greeting(name: str) -> str:
print(f'Hello, {name}!')
greeting('RiRy') # Hello, RiRy!
greeting('Casals') コメントアウト
上記のコードはコードコメントアウトができていないため SyntaxError: invalid syntax となる
警告説明文には,以下のようにコードブロックを埋め込むこともできます.
コメントアウトができていないため SyntaxError: invalid syntax となる
def greeting(name: str) -> str:
print(f'Hello, {name}!')
greeting('RiRy') # Hello, RiRy!
greeting('Casals') コメントアウト
warn
以下のようなものをwarnと呼び,注意説明文を記述するフィールドを補完できます.
これが注意説明文です
コマンド補完機能を使用して注意説明文を挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「warn」を選択します)
/warn
warn の例
警告説明文と同様に記述できます.
Pythonではインデントを揃えないとオブジェクトが無限に生成される場合があります
def greeting(name: str) -> str:
print(f'Hello, {name}!')
greeting('RiRy') # インデントが下がっているためgreeting()が再帰的に呼び出される
greeting('Casals')
info
以下のようなものをinfoと呼び,補足説明文を記述するフィールドを補完できます.
これが補足説明文です
コマンド補完機能を使用して補足説明文を挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「info」を選択します)
/info
info の例
警告説明文と同様に記述できます.
Pythonでは「->」で戻り値の型ヒントを記述できます
保守性の高いコードにするため,記述するようにしましょう
def greeting(name: str) -> str:
print(f'Hello, {name}!')
greeting('RiRy') # Hello, RiRy!
greeting('Casals') # Hello, Casals!
commentout
Qiitaのエディタ上でのコメントアウトです.
プレビュー及び公開記事では非表示になります.
コマンド補完機能を使用してコメントアウトを挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「commentout」を選択します)
/commentout
details
以下のようなものをdetailsと呼び,折りたたみテキストのフィールドを補完できます.
これが折りたたみテキストです(クリックで展開できます)
折りたたみテキストの詳細はここですコマンド補完機能を使用して折りたたみテキストを挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「details」を選択します)
/details
details の例
pythonのコメントアウトがわからない方はここを見てください
pythonのコメントアウトは以下のように記述しますprint('このテキストは表示されます') # #以降はコメントアウトされます
print('このテキストは表示されます')
'''
これは複数行コメントアウトです
「'」または「"」3つで囲むと複数行のコメントアウトになります
'''
複数行コメントアウトの場合もインデントに注意してください
reference, footnote
referenceは注釈のリンクを記述するフィールドを補完できます.
footnoteは注釈の内容を記述するフィールドを補完できます.
これらはセットで使用されます.(これがreferenceです→)1
コマンド補完機能を使用して注釈を挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「details」または「footnote」を選択します)
/details
/footnote
reference, footnote の例
pythonでは文末に「;」を記述する必要はないです.2
table
以下のようなものをtableと呼び,テーブルの記述フィールドを補完できます.
カラム1 | カラム2 |
---|---|
レコード1-1 | レコード1-2 |
レコード2-1 | レコード2-2 |
コマンド補完機能を使用してテーブルを挿入する場合は,エディタ上で以下のコードを打ちます.
(または「/」を入力した後,マウスで「table」を選択します)
/table
table の例
greeting関数の引数についてを以下にまとめました.
引数名(論理) | 引数名(物理) | 型 | 説明 |
---|---|---|---|
名前 | name | str | 挨拶をしたい対象者の名前です |
コマンド補完機能では2x2のテーブルの補完しかできませが,
2x3のように 列数x行数 と記述することで様々なサイズのテーブルを補完することが可能です.
まとめ
コマンド補完機能により様々ないろいろな入力フィールドの保管が可能になりました.
特に alert, warn, info は便利なので活用していきたいですね!
おまけ
びっくりしたのが,エディタにリア校正機能が備わっていました!
これで読みやすい文章作成がはかどります!