microsoft / microsoft/vscode-cpptools

Documentation for `C_Cpp.codeAnalysis.clangTidy.enabled` in relation to `C_Cpp.codeAnalysis.runAutomatically`

Aperta
#12,682 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

docs Feature: Code Analysis Language Service question
Lingua principale
TypeScript
Stelle
6.2k
Fork
1.7k
Merge medio
14h 46m
PR unite (30g)
61

Descrizione

The documentation for these settings is not possible to understand completely:

  // If `true`, code analysis using `clang-tidy` will be enabled and will run after a file is opened or saved if `C_Cpp.codeAnalysis.runAutomatically` is `true` (the default).
  "C_Cpp.codeAnalysis.clangTidy.enabled": false,

  // If `true`, code analysis will run automatically on a file after it is opened or saved.
  "C_Cpp.codeAnalysis.runAutomatically": true
Open question

Why is C_Cpp.codeAnalysis.clangTidy.enabled even required to have? What happens if it is set to true but C_Cpp.codeAnalysis.runAutomatically is set to false? The problem is that it is not evident what C_Cpp.codeAnalysis.clangTidy.enabled actually does.

Even if C_Cpp.codeAnalysis.clangTidy.enabled is false, it works fine to execute the command C/C++: Run Code Analysis on Active File when having a C file open.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con le descrizioni di C_Cpp.codeAnalysis.clangTidy.enabled e C_Cpp.codeAnalysis.runAutomatically, quindi esamina il comportamento di C/C++: Run Code Analysis on Active File. Verifica in che modo ciascuna impostazione influisce sull'analisi automatica e manuale. Il lavoro è completo quando la documentazione spiega chiaramente la loro relazione e l'effetto di ogni combinazione true/false.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.