Skip to end of metadata
Go to start of metadata


XML Annotation Language Server

Define annotations and write error free code thereby increasing your efficiency and enabling code consistency.



Introduction

Allows you to access resources that help to define annotations in the code editor thus improving the application development by reducing effort and ensuring code consistency. The following is a subset of features that are part of this extension: code completion, micro-snippets, diagnosticsand i18n support.

Features

Code Completion:

The extension provides a list of suggestions based on the project metadata and OData vocabularies. An application developer can open such a list of suggested values for annotation targets, terms, and different elements of annotation values in the annotation file and accept one of the suggestions to add or change them. This eliminates the need to look up the valid values or type complete values thus improving the development efficiency.

Micro-Snippets

The  provides a number of generic micro-snippets, which helps the application to accelerate the annotation definition. Bigger blocks of code get inserted and there is no need to trigger the code completion for each element or attribute. An application developer can insert repeating code patterns such as Annotations, Annotation, Record, and PropertyPath more efficiently.

Diagnostics (error-checking):

The extension validates the annotation file against the project metadata, annotation vocabularies, and OData specification. An application developer can view the diagnostic messages and navigate to the related place in the annotation file to fix the issues.

Documentation (Vocabulary Information):

The  extension provides vocabulary information for annotation terms and their elements, such as property values, record types, etc. This information may include a description, applicability, type, etc. It also indicates if a term/element is experimental or deprecated and informs the developer if the element is mandatory. An application developer can use this information to make a better decision on how to use the annotation. The documentation scope depends on the information provided in the respective vocabulary.

Go to Definition:

The Go To Definition feature helps you to navigate to the source of annotation or translatable string value and opens the result in a new tab.

Peek Definition:

The Peek Definition feature lets you preview the definition of annotation or translatable string value without switching away from the code that you're writing.

i18n Support:

The SAP Fiori tools - XML Annotation Language Server provides diagnostic warning for translatable texts which are not maintained in the i18n.properties file. An application developer can use code completion or quick fix to solve the issue.


Useful links

Project Gallery

Code Completion



  • No labels