Nieprawidłowy wzorzec JSON (JSON001)
| Właściwości | Wartość |
|---|---|
| Identyfikator reguły | JSON001 |
| Tytuł | Nieprawidłowy wzorzec JSON |
| Kategoria | Styl |
| Podkategorii | Nie dotyczy |
| Odpowiednie języki | C#, Visual Basic |
| Opcje | Zobacz sekcję Opcje . |
Omówienie
Ta reguła flaguje miejsca, w których ciąg literału JSON nie jest zgodny z wymaganą składnią. Reguła ma zastosowanie do zidentyfikowanego kodu JSON, który jest określany przez dołączenie komentarza wbudowanego lub komentarza poprzedzającego ciąg JSON, na przykład //lang=json lub //lang=json,strict. Ten ostatni komentarz używa ścisłego trybu interpretacji kodu JSON.
Ta reguła dotyczy tylko środowiska IDE i nie dotyczy scenariuszy wiersza polecenia.
Opcje
Opcje określają zachowanie, które ma być wymuszane przez regułę.
Dla kodu rozpoznawany jako JSON można ustawić opcje w programie Visual Studio, wybierając pozycję Narzędzia>Opcje>Edytor>tekstów C# | Visual Basic>Advanced. W sekcji ciągów JSON są dostępne następujące opcje:
| Właściwości | opis |
|---|---|
| Kolorowanie ciągów JSON | Określa, czy kolorować ciągi JSON. |
| Zgłoś nieprawidłowy kod JSON | Określa, czy raportować nieprawidłowy kod JSON. |
| Wyróżnianie powiązanych składników pod kursorem | Określa, czy funkcja Szybkie akcje używa wyróżniania. |
Przykład
Poniższy fragment kodu przedstawia przykład z nieprawidłowym kodem JSON.
// Code with violations
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3 }""";
// Fixed code
// lang=json,strict
var v = """{ "pie": true, "cherry": [1, 2, 3] }""";
// Code with violations
//lang=json,strict
var v = """
{
"pie": true,
// Comments not allowed in strict mode
"cherry": [1, 2, 3]
}
""";
// Fixed code
//lang=json
var v = """
{
"pie": true,
// Comments allowed if not using strict mode
"cherry": [1, 2, 3]
}
""";
Pomijanie ostrzeżenia
Jeśli chcesz pominąć tylko jedno naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.
#pragma warning disable JSON001
// The code that's violating the rule is on this line.
#pragma warning restore JSON001
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji.
[*.{cs,vb}]
dotnet_diagnostic.JSON001.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia dotyczące analizy kodu.