Content deleted Content added
m Reverted 2 edits by 111.248.10.12 (talk) to last revision by KNHaw. (TW) |
Tag: extraneous markup |
||
Line 151:
A public API can sometimes declare parts of itself as ''[[Deprecation|deprecated]]''. This usually means that such part of an API should be considered candidates for being removed, or modified in a backward incompatible way. Therefore, deprecation allows developers to transition away from parts of the API that will be removed or unsupported in the future.<ref name="OracleDeprecation16">{{cite web|last1=Oracle|title=How and When to Deprecate APIs|url=http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/deprecation.html|website=Java SE Documentation|accessdate=2 August 2016}}</ref>
<ref></ref>==Documentation==
API documentation describes what services an API offers and how to use those services, aiming to cover everything a client would need to know to use the API.
Documentation is crucial for the development and maintenance of applications that use the API.<ref name="DekelHerbsleb9">{{cite journal|last1=Dekel|first1=Uri|last2=Herbsleb|first2=James D.|title=Improving API Documentation Usability with Knowledge Pushing|journal=Institute for Software Research, School of Computer Science|date=May 2009|url=http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.446.4214&rep=rep1&type=pdf|accessdate=22 July 2016|publisher=Carnegie Mellon University}}</ref>
| |||