Programprogrammeringsgränssnitt (API) exponeras för utvecklare för att återanvända programvarubibliotek. API-direktiv är naturliga språkförklaringar i API-dokumentation som gör utvecklare medvetna om begränsningar och riktlinjer relaterade till användningen av ett API. I detta dokument presenteras utformningen och resultaten av en empirisk studie av direktiven om API-dokumentation av objektorienterade bibliotek. Dess huvudsakliga bidrag är att föreslå och ingående diskutera en taxonomi av 23 typer av API-direktiv. Prototypiska exempel "@param obj måste vara ett tal eller ett datum.", 35 "Den Cert-Path specif ied måste vara av en typ som stöds av valideringsalgoritmen, annars en InvalidAlgorithmParameterException kommer att kastas.", 36 "@param obj [skrivs som 32 i JDK's Statement.execute(sql, autoGenerated Keys) 33 i JDK:s ServerSocket.ServerSocket(port, backlog, bindAdder) 34 i JDK:s Callable Statement.registerOutParameter(parameterIndex, sqlType, skala) 35 i JDK:s DateFormat.format(obj, toAppendTo, fieldPosition) 36 i JDK:s CertPathValidator.validate(certPath, params)
Monperrus m.fl. REF genomförde en empirisk studie av direktiven, och 23 olika typer av direktiv utarbetades och diskuterades.
What should developers be aware of? An empirical study on the directives of API documentation
{'venue': 'Empirical Software Engineering', 'journal': 'Empirical Software Engineering', 'mag_field_of_study': ['Computer Science']}