PowerShell / PowerShell/PSScriptAnalyzer
Add setting to better toggle block comments
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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!
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando l'implementazione dell'attivazione/disattivazione dei commenti di blocco e l'impostazione esistente dello stile di indentazione delle pipeline in PSScriptAnalyzer. Confronta il comportamento attuale con le linee guida collegate di PowerShellPracticeAndStyle. Il lavoro è completato quando l'impostazione o le impostazioni scelte collocano <# e #> su righe proprie e indentano il contenuto del blocco quando i commenti vengono attivati/disattivati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100