PowerShell / PowerShell/PSScriptAnalyzer

Add setting to better toggle block comments

Abierto
#1,428 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Area - Formatter Issue - New Rule Up-for-Grabs
Lenguaje dominante
C#
Estrellas
2.2k
Forks
414
Merge medio
13 h 1 min
PR fusionados (30 d)
2

Descripción

Force block comment start (<#) and end (#>) to be on their own line and indent contents

When toggling a block comment the contents are not indented and if white space was not selected the start and end tags will not be on their own lines.
I propose a setting (or two) that would force a newline for the start and end tags and possibly indent the contents. This way when someone goes to toggle block comment it would already be pretty inline with outlined in https://github.com/PoshCode/PowerShellPracticeAndStyle.

Perhaps a dropdown with block comment style similar to the pipeline indentation style option.

I would like that when you toggle block comment that it matches the definition in https://github.com/PoshCode/PowerShellPracticeAndStyle/blob/master/Style-Guide/Documentation-and-Comments.md
This is to say the start and end tags on their own lines and the content indented once.

Appreciate any consideration to add this!

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando la implementación del comentario de bloque conmutado y la configuración existente del estilo de indentación de canalizaciones en PSScriptAnalyzer. Compara el comportamiento actual con las directrices enlazadas de PowerShellPracticeAndStyle. Se considera terminado cuando la configuración o configuraciones elegidas colocan <# y #> en sus propias líneas y aplican indentación al contenido del bloque al alternar los comentarios.

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

Evaluación

Stack tecnológico
csharp, powershell
Área
tooling
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.