Qualitatively Annotated Code

• US 20070180455A1
• Filed: 01/24/2006
• Published: 08/02/2007
• Est. Priority Date: 01/24/2006
• Status: Active Grant

• Current Assignee: Microsoft Technology Licensing LLC (Microsoft Corporation)
• Original Assignee: Microsoft Corporation
• Inventors: Mariani, Rico
• Granted Patent: US 7,987,456 B2
• Time in Patent Office: Days
• US Class Current: 719/328
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

Data associated with at least one module of code may be annotated in such a manner as to provide guidance regarding usage of the module.

Claims

1. At least one computer-readable medium having a data structure stored thereon, the data structure comprising:

an application programming interface (API); and

an annotation prescribing programming guidance based on a qualitative attribute of the API.

2. At least one computer-readable medium according to claim 1, wherein the API is pre-compiled.

3. At least one computer-readable medium according to claim 1, wherein the API is not yet compiled.

4. At least one computer-readable medium according to claim 1, wherein the programming guidance indicates at least one rule for using the API.

5. At least one computer-readable medium according to claim 1, wherein the programming guidance indicates whether the API is functionally compatible with a method that is calling the API.

6. At least one computer-readable medium according to claim 1, wherein the programming guidance indicates whether a called method is functionally compatible with the API.

7. At least one computer-readable medium according to claim 1, wherein the programming guidance identifies a method that may be successfully called by the API.

8. At least one computer-readable medium according to claim 1, wherein the annotation indicates a classification of the API.

9. At least one computer-readable medium according to claim 1, wherein the annotation indicates a classification of the API and further indicates a functionally compatible classification of another API.

10. At least one computer-readable medium according to claim 1, wherein the programming guidance appears when an action is taken to affect the API.

11. At least one computer-readable medium according to claim 1, wherein the programming guidance appears in a dialog-box when an action is taken to affect the API.

12. At least one computer-readable medium according to claim 1, wherein the programming guidance appears in a drop-down menu when an action is taken to affect the API.

13. A system, comprising:

a receiver to receive code; and

an administrator to provide programming guidance based on a qualitative characteristic of the code.

14. A system according to claim 13, wherein the received code is compiled.

15. A system according to claim 13, wherein the received code is annotated on a qualitative basis, and wherein further the administrator is to provide the guidance based on the annotation corresponding to the received code.

16. A system according to claim 13, wherein the received code is annotated with a qualitatively-based persona, and wherein further the administrator is to provide the guidance indicating another qualitatively-based persona that is functionally compatible with the received code.

17. A system according to claim 13, wherein the received code is annotated with a classification based on a functional intent thereof, and wherein further the administrator is to provide the guidance indicating another classification for code that is functionally compatible with the classification of the received code.

18. A system according to claim 13, wherein the received code is annotated with a functionality classification that is based on a security characteristic of the received code.

19. A system according to claim 13, wherein the system is a profiler.

20. A system according to claim 13, wherein the system is a diagnostic tool.