microsoft / microsoft/vscode-cpptools
Documentation for `C_Cpp.codeAnalysis.clangTidy.enabled` in relation to `C_Cpp.codeAnalysis.runAutomatically`
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 6.2k
- Forks
- 1.7k
- Ø Merge
- 14 Std. 46 Min.
- Gemergte PRs (30 T.)
- 61
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit den Beschreibungen von C_Cpp.codeAnalysis.clangTidy.enabled und C_Cpp.codeAnalysis.runAutomatically und untersuche anschließend das Verhalten von C/C++: Run Code Analysis on Active File. Überprüfe, wie sich jede Einstellung auf die automatische und manuelle Analyse auswirkt. Die Aufgabe ist abgeschlossen, wenn die Dokumentation ihre Beziehung und die Auswirkungen jeder true/false-Kombination klar erklärt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100