När programmerare stöter på ett okänt API-bibliotek behöver de ofta hänvisa till dess dokumentation, handledningar eller diskussioner om utvecklingsforum för att lära sig dess korrekta användning. Dessa API-dokument innehåller värdefull information, men kan också vilseleda programmerare eftersom de kan innehålla fel (t.ex. trasiga kodnamn och föråldrade kodprover). Även om de flesta API-dokumenten aktivt underhålls och uppdateras, visar studier att det finns många nya och latenta fel. Det är tröttsamt och felbenäget att hitta sådana fel manuellt som API-dokument kan vara enorm med tusentals sidor. Befintliga verktyg är ineffektiva när det gäller att hitta dokumentationsfel eftersom traditionella naturliga språk (NL) verktyg inte förstår kodnamn och kodprover, och traditionella kodanalysverktyg inte förstår NL meningar. I detta dokument föreslår vi det första tillvägagångssättet, DOCREF, som är särskilt utformat och utvecklat för att upptäcka fel i API-dokumentationen. Vi formulerar en klass av inkonsekvenser för att indikera potentiella dokumentationsfel, och kombinera NL- och kodanalysteknik för att upptäcka och rapportera sådana inkonsekvenser. Vi har implementerat DOCREF och utvärderat dess effektivitet på de senaste dokumenten från fem allmänt använda API-bibliotek. DOCREF har upptäckt mer än 1000 nya dokumentationsfel, som vi har rapporterat till författarna. Många av felen har redan bekräftats och rättats till, efter att vi rapporterat dem.
Zhong och Su REF formulerade en uppsättning inkonsekvenser och kombinerad behandling av naturligt språk samt metoder för kodanalys för att hitta dessa inkonsekvenser, och mer än 1000 fel upptäcktes och rapporterades.
Detecting API documentation errors
{'venue': "OOPSLA '13", 'journal': None, 'mag_field_of_study': ['Computer Science']}