Předvolby chyb a varování API

Níže uvedené preference lze nastavovat na stránce předvoleb Otevře stránku předvoleb konzoly Vývoj modulu plug-in > Chyby/varování API.

Problémy API se vytvářejí během sestavování projektů (automatická a plná sestavení), nástroje dělí typy problémů na tři kategorie:

  1. Problémy použití - omezený kód je volán neautorizovanými moduly plug-in.
  2. Nekompatibility rozhraní API - nejsou kompatibilní změny mezi verzemi.
  3. Problémy verzí - verze modulů plug-in nebo verze kódu (značky @since) nejsou správné.
  4. Volby analýzy - obecné volby.

Můžete také konfigurovat závažnosti problémů pro jednotlivé projekty pomocí stránky vlastností Chyby/varování API pro projekt

Použití rozhraní API

Stránka předvoleb Volby použití API

Obecné

Volba

Popis

Výchozí

Nepodporované použití značek dokumentace Javadoc rozhraní API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda nejsou značky dokumentace Javadoc API používány chybně.

Ignorovat

Odkaz není definován v určeném prováděcím prostředí

Je-li volba povolena, tvůrce analýzy API zkontroluje odkazy na systémové knihovny, které by podle prováděcího prostředí určeného pro balík mohly být nepovolené.

Ignorovat

Omezení

Volba

Popis

Výchozí

Implementace rozhraní značeného jako '@noimplement'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda nejsou označená rozhraní implementována nepovoleně.

Varování

Rozšíření typu značeného jako '@noextend'

Je-li volba povolena, tvůrce analýzy API zkontroluje třídy, které rozšiřují označené typy.

Varování

Odkazování na pole nebo metodu značené jako '@noreference'

Je-li volba povolena, tvůrce analýzy API zkontroluje odkazy polí a metod na označené členy.

Varování

Vytvoření instance třídy značené jako '@noinstantiate'

Je-li volba povolena, tvůrce analýzy zkontroluje, zda označené třídy nejsou převedené na instanci.

Varování

Potlačení metody značené jako '@nooverride'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda označené metody v nadřízených třídách nejsou potlačeny v některé podřízené třídě buďto rozšířením (reimplementace s voláním potlačeného nadřízeného prvku), nebo reimplementací (bez volání potlačeného nadřízeného prvku).

Varování

Úniky

Volba

Popis

Výchozí

Rozšiřuje třídu jinou než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé třídy API rozšiřují jiné typy než API.

Varování

Implementuje rozhraní jiné než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé třídy API implementují jiné rozhraní než API.

Varování

Pole s typem jiným než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé typy API mají veřejná nebo chráněná pole s jinými typy než API.

Varování

Metoda s návratovým typem jiným než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé typy API mají veřejné nebo chráněné metody s jinými návratovými typy než API.

Varování

Metoda s typem parametru jiným než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé typy API mají veřejné nebo chráněné metody s jinými typy parametrů než API.

Varování

Kompatibilita API

Stránka předvoleb volby kompatibility API

Volba

Popis

Výchozí

Ohlásit změny rozhraní API, i když jsou autorizovány zvýšením hlavní verze

Je-li volba povolena, tvůrce analýzy API ohlásí problémy se změnami rozhraní API, i když už byla zvýšena hlavní verze balíku.

Zakázáno

Balík

Volba

Popis

Výchozí

Typ API se stal jiným typem než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé typy API v aktuálním balíku změněny na typy jiné než API.

Chyba

Byl odebrán typ

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé typy API byly odebrány z rozsahu platnosti API v daném balíku.

Chyba

Reexportovaný typ API se stal typem jiným než API

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé reexportované typy API v aktuálním balíku změněny na typy jiné než API.

Chyba

Byl odebrán reexportovaný typ

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé reexportované typy API odebrány z rozsahu platnosti API v daném balíku.

Chyba

Třída

Volba

Popis

Výchozí

Byla přidána metoda (kterou je třeba implementovat):

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly k nějakým typům API přidány veřejné nebo chráněné metody, které je třeba implementovat.

Chyba

Byla přidána omezení

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k některým třídám API přidána omezení API.

Chyba

Byl přidán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly k některým třídám API přidány nějaké parametry typu.

Chyba

Byla zjednodušena hierarchie superrozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla z některých tříd API odebrána nějaká nadřízená rozhraní.

Chyba

Bylo přidáno klíčové slovo 'abstract'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k některé třídě API přidáno klíčové slovo 'abstract'.

Chyba

Bylo přidáno klíčové slovo 'final'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k některé třídě API přidáno klíčové slovo 'final'.

Chyba

Převedeno na anotaci, výčet nebo rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé třídy API změněny na anotace, výčty nebo rozhraní.

Chyba

Byla snížena viditelnost

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé veřejné třídy API změněny na chráněné nebo na výchozí rozsah.

Chyba

Bylo odebráno pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla z některé třídy API odebrána nějaká veřejná nebo chráněná pole.

Chyba

Byla odebrána metoda

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některé třídy API odebrány nějaké veřejné nebo chráněné metody.

Chyba

Byl odebrán konstruktor

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některé třídy API odebrány nějaké veřejné nebo chráněné konstruktory.

Chyba

Byla zjednodušena hierarchie supertřídy

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z hierarchie odebrány nějaké supertřídy.

Chyba

Byl odebrán typ člena

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některých tříd API odebrány nějaké typy členů.

Chyba

Byl odebrán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některé třídy API odebrány nějaké parametry typu.

Chyba

Rozhraní

Volba

Popis

Výchozí

Bylo přidáno pole (rozhraní neznačené jako '@noimplement')

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly k některé anotaci API přidána nějaká veřejná pole.

Chyba

Byla přidaná metoda (rozhraní neznačené jako '@noimplement')

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly k některému rozhraní API přidány nějaké veřejné metody.

Chyba

Byla přidána omezení

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některá rozhraní API přidána omezení API.

Chyba

Byl přidán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly k některému rozhraní API přidány nějaké parametry typu.

Chyba

Převedeno na třídu, výčet nebo anotaci

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla některá rozhraní API změněna na třídy, výčty nebo rozhraní.

Chyba

Byla zjednodušena hierarchie superrozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některá rozhraní API odebrána nějaká nadřízená rozhraní.

Chyba

Byl odebrán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého rozhraní API odebrány nějaké parametry typu.

Chyba

Bylo odebráno pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého rozhraní API odebrána nějaká veřejná pole.

Chyba

Byla odebrána metoda

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého rozhraní API odebrány nějaké veřejné metody.

Chyba

Byl odebrán typ člena

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého rozhraní API odebrány nějaké typ y člena.

Chyba

Výčet

Volba

Popis

Výchozí

Byla zjednodušena hierarchie superrozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla z některých výčtů API odebrána nějaká nadřízená rozhraní.

Chyba

Převedeno na anotaci, třídu nebo rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly některé výčty API změněny na anotace, třídy nebo rozhraní.

Chyba

Bylo odebráno pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého výčtu API odebrána nějaká veřejná pole.

Chyba

Byla odebrána výčtová konstanta

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla z některých výčtů API odebrány nějaké výčtové konstanty.

Chyba

Byla odebrána metoda

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého výčtu API odebrány nějaké veřejné metody.

Chyba

Byl odebrán typ člena

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některého výčtu API odebrány nějaké typy člena.

Chyba

Anotace

Volba

Popis

Výchozí

Byla přidána metoda bez výchozí hodnoty

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k anotacím API přidána metoda bez výchozí hodnoty.

Chyba

Převedeno na třídu, výčet nebo rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly nějaké anotace API převedeny na třídy, výčty nebo rozhraní.

Chyba

Bylo odebráno pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některé anotace API odebrána nějaká veřejná pole.

Chyba

Byla odebrána metoda

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některých anotací API odebrány nějaké veřejné metody.

Chyba

Byl odebrán typ člena

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly z některých anotací API odebrány nějaké veřejné typy členů.

Chyba

Pole

Volba

Popis

Výchozí

Byla přidána konstantní hodnota

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některý typ API přidána konstantní hodnota k nějaké dříve neinicializované konstantě veřejného nebo chráněného pole.

Chyba

Typ byl pozměněn

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl pro některý typ API změněn typ nějakého veřejného nebo chráněného pole.

Chyba

Konstantní hodnota byla upravena

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některý typ API změněna hodnota nějaké konstanty veřejného nebo chráněného pole.

Chyba

Byla snížena viditelnost

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda bylo v některém typu API nějaké veřejné nebo chráněné pole změněno na soukromé.

Chyba

Bylo odebráno klíčové slovo 'final' pro statickou konstantu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda v některém typu API mělo nějaké veřejné nebo chráněné pole odebráno klíčové slovo final.

Chyba

Bylo přidáno klíčové slovo 'final'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda bylo k některému veřejnému nebo chráněnému poli v některém typu API přidáno klíčové slovo final.

Chyba

Bylo odebráno klíčové slovo 'static'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda bylo z některého veřejného nebo chráněného pole v některém typu API odebráno klíčové slovo static.

Chyba

Bylo přidáno klíčové slovo 'static'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda bylo k některému veřejnému nebo chráněnému poli v některém typu API přidáno klíčové slovo static.

Chyba

Byla odebrána konstantní hodnota

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některé veřejné nebo chráněné pole v některém typu API odebrána hodnota konstantního pole.

Chyba

Byl odebrán argument typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl z některého veřejného nebo chráněného pole v nějakém typu API odebrán argument typu.

Chyba

Metoda

Volba

Popis

Výchozí

Bylo přidáno omezení @nooverride

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla v nějakých typech API změněna omezení nějakých veřejných či chráněných metod doplněním značky @nooverride.

Chyba

Byl přidán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl k některé veřejné nebo chráněné metodě pro některý typ API přidán parametr typu.

Chyba

Argument proměnné převeden na typ pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl pro některou veřejnou nebo chráněnou metodu pro některý typ API argument varargs rozbalen na pole objektů.

Chyba

Byla snížena viditelnost

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla pro některý typ API nějaká veřejná nebo chráněná metoda změněna na soukromou.

Chyba

Bylo přidáno klíčové slovo 'abstract'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla v některém typu API nějaká veřejná nebo chráněná metoda změněna na abstraktní.

Chyba

Bylo přidáno klíčové slovo 'static'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla v některém typu API nějaká veřejná nebo chráněná metoda změněna na statickou.

Chyba

Bylo odebráno klíčové slovo 'static'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla v některém typu API nějaká veřejná nebo chráněná metoda změněna na nestatickou.

Chyba

Bylo přidáno klíčové slovo 'final' (typ značený jako '@noextend')

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly v některých typech API, které jsou označeny jako @noextend, změněny nějaké veřejné nebo chráněné metody na konečné.

Chyba

Byla odebrána výchozí hodnota anotace

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla odebrána výchozí hodnota přidružená k nějaké metodě anotace API.

Chyba

Byl odebrán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl z některé veřejné nebo chráněné metody pro některý typ API odebrán parametr typu.

Chyba

Konstruktor

Volba

Popis

Výchozí

Byl přidán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl k některému veřejnému konstruktoru pro některý typ API přidán parametr typu.

Chyba

Argument proměnné převeden na typ pole

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byly pro některé veřejné konstruktory pro některý typ API rozbaleny nějaké parametry varargs na pole objektů.

Chyba

Byla snížena viditelnost

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl v některém typu API nějaký veřejný konstruktor změněn na neveřejný.

Chyba

Byl odebrán parametr typu

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byl z některého veřejného konstruktoru pro některý typ API odebrán parametr typu.

Chyba

Parametr typu

Volba

Popis

Výchozí

Bylo přidáno omezení ke třídě

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k některému parametru typu nějakého typu API přidána omezení ke třídě.

Chyba

Byl přidáno omezení k rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla k některým parametrům typu nějakých typů API přidána nějaká omezení k rozhraní.

Chyba

Bylo upraveno omezení ke třídě

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla u některého parametru typu nějakých typů API změněna nějaká omezení ke třídě.

Chyba

Bylo upraveno omezení k rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla u některého parametru typu nějakých typů API změněna nějaká omezení k rozhraní.

Chyba

Bylo odebráno omezení ke třídě

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla od některého parametru typu nějakých typů API odebrána nějaká omezení ke třídě.

Chyba

Bylo odebráno omezení k rozhraní

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda byla od některého parametru typu nějakých typů API odebrána nějaká omezení k rozhraní.

Chyba

Správa verzí

Stránka předvoleb Volby správy verzí API

Volba

Popis

Výchozí

Informovat o chybějících značkách '@since'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda chybějí značky @since pro typy nebo členy přidané od vydání verze používané úrovně baseline API.

Chyba

Informovat o chybných značkách '@since'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda jsou některé aktuálně používané značky @since chybné (nesprávná syntaxe).

Chyba

Informovat o neplatné verzi značky '@since'

Je-li volba povolena, tvůrce analýzy API zkontroluje, zda některé aktuálně používané značky @since nemají nesprávnou verzi.

Chyba

Informovat o nekompatibilní verzi balíku

Je-li volba povolena, tvůrce analýzy API na základě změn API a aktuálně používané úrovně baseline API zkontroluje, zda není verze balíku pro modul plug-in chybná.

Chyba

Ignorovat malý přírůstek čísla verze bez změn API

Je-li povoleno oznamování nekompatibilních čísel verze, lze tuto volbu použít ke sdělení, aby tvůrce analýzy API ignoroval změny vedlejšího čísla verze, pokud nedošlo ke změně API v porovnání s aktuální úrovní baseline API.

Zapnout

Ignorovat velký přírůstek čísla verze bez změn API

Je-li povoleno oznamování nekompatibilních čísel verze, lze tuto volbu použít ke sdělení, aby tvůrce analýzy API ignoroval změny hlavního čísla verze, pokud nedošlo ke změně API v porovnání s aktuální úrovní baseline API.

Zapnout

Volby analýzy

Stránka předvoleb s volbami analýzy

Volba

Popis

Výchozí

Balíku chybí nezbytné omezení/předpoklad

Je-li volba povolena, tvůrce analýzy API ohlásí jakákoli chybějící nezbytná omezení nebo nezbytné předpoklady, které tvůrci brání v provedení úplné analýzy. Bez ohledu na hodnotu této volby se analýza příslušného balíku přeskočí.

Chyba

Nepoužívané filtry problémů rozhraní API

Pokud je povoleno, tvůrce analýz rozhraní API nahlásí jakékoli dále nepoužívané filtry problémů rozhraní API.

Varování

Volby skenování API use scan

Stránka předvoleb Volby skenování API use scan

Volba

Popis

Výchozí

Nevyřešený problém typu

Je-li volba povolena, tvůrce analýzy API nahlásí jakékoli odebrané typy rozhraní API, které jsou zahrnuty v jakémkoli procházení použití uvedeném na stránce předvoleb Skenování API use scan.

Chyba

Nevyřešený problém metody

Je-li volba povolena, tvůrce analýzy API nahlásí jakékoli odebrané metody, které jsou zahrnuty v jakémkoli procházení použití uvedeném na stránce předvoleb Skenování API use scan.

Chyba

Nevyřešený problém pole

Je-li volba povolena, tvůrce analýzy API nahlásí jakákoli odebraná pole, která jsou zahrnuta v jakémkoli procházení použití uvedeném na stránce předvoleb Skenování API use scan.

Chyba


Související odkazy

Předvolby PDE
Stránka vlastností chyb a varování API
Předvolby úrovní baseline rozhraní API
Předvolby skenování API Use Scan