elementary / elementary/code

Distinguish temporary and permanent comments

Aperta
#961 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Needs Design Priority: Wishlist
Lingua principale
Vala
Stelle
521
Fork
118
Merge medio
1g 8h
PR unite (30g)
14

Descrizione

## 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.

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.