Code Annotation Transformations
From APIDesign
| Line 3: | Line 3: | ||
We have observed that using '''@Deprecated''' annotation is good hint to help your [[API]] users recognize that some part of your [[API]] is obsolete and shall no longer be used, however that in no way helps users of your [[API]] with converting their code to new, non-deprecated style. | We have observed that using '''@Deprecated''' annotation is good hint to help your [[API]] users recognize that some part of your [[API]] is obsolete and shall no longer be used, however that in no way helps users of your [[API]] with converting their code to new, non-deprecated style. | ||
| - | With the use of [[Code | + | With the use of [[Code Annotation Transformations]] this can be much simplified! When [[API]] writers adopt these annotations and use them in your API, they can specify suggested refactorings that are supposed to happen when someone is using a '''@Deprecated''' [[API]] element. Then any IDE can pick recognize these annotations and offer automated upgrade of the sources using the [[API]] in an old-fashioned way. |
Current revision
This is a software project that can improve communication between API designers and API users.
We have observed that using @Deprecated annotation is good hint to help your API users recognize that some part of your API is obsolete and shall no longer be used, however that in no way helps users of your API with converting their code to new, non-deprecated style.
With the use of Code Annotation Transformations this can be much simplified! When API writers adopt these annotations and use them in your API, they can specify suggested refactorings that are supposed to happen when someone is using a @Deprecated API element. Then any IDE can pick recognize these annotations and offer automated upgrade of the sources using the API in an old-fashioned way.
Read more...
Follow
