elementary / elementary/code

Distinguish temporary and permanent comments

オープン
#961 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
Needs Design Priority: Wishlist
主要言語
Vala
スター
521
フォーク
118
平均マージ
1日 8時間
マージ済み PR(30日)
14

説明

## Problem
Comments in code may serve more than one purpose:
- Informative comments in addition to the code
- Code commented out for development purposes

It would be useful to distinguish the two so that the latter can be quickly found and removed from a final PR.

At present, `M` places `//` at the start of the text (indented if required) and so it is indistinguishable from an informative comment.

## Proposal
When toggling comment on code lines with `M` the line is commented out with (e.g. `//~`) at the very start of the line. Informative comments can then use `//` or `/*`. Moreover a search for `//~` will find the temporarily commented out code quickly.

## Prior Art
Geany uses `//~` at the start of the line for toggled comments.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

まずエディターで M のコメント切り替えコマンドを追跡し、その現在の出力を issue で言及されている Geany の規約と比較します。完了条件は、切り替えられたコード行の行頭で //~ を使用し、情報提供用のコメントでは引き続き // または /* を使用でき、一時的なコメントを検索できることです。

索引モデルが issue の本文から書いたものです。

評価

領域
desktop, devtools
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
52/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。