elementary / elementary/code

Distinguish temporary and permanent comments

Abierto
#961 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Needs Design Priority: Wishlist
Lenguaje dominante
Vala
Estrellas
521
Forks
118
Merge medio
1 d 8 h
PR fusionados (30 d)
14

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza siguiendo el comando de alternancia de comentarios M en el editor y compara su salida actual con la convención de Geany mencionada en el issue. Se considera terminado cuando las líneas de código alternadas usan //~ al principio de la línea, mientras que los comentarios informativos pueden seguir usando // o /* y los comentarios temporales se pueden buscar.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
desktop, devtools
Tipo de issue
Nueva funcionalidad
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
52/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.