Dołączanie komentarzy kodu źródłowego COBOL do wygenerowanych plików XSD i WSDL

Edytuj w trybie z połączeniem

W tym temacie opisano opcję umożliwiającą dodanie komentarzy z pliku kodu źródłowego w języku COBOL do plików XSD i WSDL, które są tworzone podczas generowania usługi Web Service przy użyciu metody wstępującej i przy użyciu skompilowanej konwersji XML w projekcie pojedynczej usługi.

Ta opcja jest dostępna zarówno w kreatorze tworzenia nowego interfejsu usługi (wstępujący) (patrz sekcja Ustawianie preferencji dla konwerterów XML w języku COBOL), jak i w procesorze wsadowym wiersza komend (patrz właściwość GEN_COMMENT_IN_XSD w sekcji CodegenProperty).

W poniższej tabeli przedstawiono typy plików, które są używane jako pliki wejściowe, oraz niektóre pliki, które są generowane jako pliki wyjściowe podczas tworzenia usługi Web Service przy użyciu metody wstępującej i przy użyciu skompilowanej konwersji XML w procesorze wsadowym (patrz sekcja Typy projektów pojedynczej usługi):
Typ pliku: Cel:
Plik wejściowy: Plik kodu źródłowego COBOL lub plik struktury copybook Ten plik zawiera strukturę języka żądania i strukturę języka odpowiedzi określoną dla usługi Web Service.
Wyjściowe pliki WSDL i XSD: Plik WSDL Ten plik opisuje usługę Web Service.
Dwa pliki XSD Te dwa pliki opisują format komunikatu, który jest pochodną struktury danych języka żądania i struktury danych języka odpowiedzi .

Jeśli opcja opisana w tym temacie jest włączona, generator kodu środowiska wykonawczego wyodrębnia komentarze z pliku kodu źródłowego COBOL i dodaje komentarze do pliku WSDL i do dwóch plików XSD opisanych w poprzedniej tabeli.

Poniższa tabela zawiera bardziej szczegółowy opis tej opcji:
Element: Opis:
Które wiersze komentarza są wyodrębniane:
  • Każdy wiersz komentarza jest wyodrębniany, rozpoczynając od początku pliku źródłowego, i kontynuując, ale nie uwzględniając, który z następujących elementów jest pierwszy:
    • Pierwsza instrukcja PROCEDURE DIVISION. Jeśli plik źródłowy nie zawiera instrukcji PROCEDURE DIVISION, każdy wiersz komentarza jest wyodrębniany z pliku źródłowego.
    • Następna dostępna grupa level 01 po grupie level 01 wybranej dla interfejsu.

  • Komentarze są wyodrębniane tylko z określonego pliku kodu źródłowego COBOL, a nie z plików COPY, do których mogą się odwoływać.

  • Wyodrębniane są tylko wiersze komentarza (utworzone przez umieszczenie znaku * w kolumnie 7). Wpisy komentarzy i opcjonalne akapity nie są wyodrębniane.
Miejsce umieszczenia wierszy komentarza w plikach XSD i WSDL: Wyodrębnione wiersze komentarza w każdym elemencie danych COBOL poziomu 01 w pliku kodu źródłowego COBOL są dodawane do elementu documentation elementu annotation należącego do typu danych najwyższego poziomu pochodzącego z tego elementu danych COBOL poziomu 01.
Odwołania do jednostek: Znaki używane w języku XML jako predefiniowane odwołania do jednostek są zastępowane przez ich rozwinięte formy. Na przykład symbol ampersand (&) jest zastępowany przez łańcuch reprezentujący rozszerzenie jednostki ampersand.
Znaki wielobajtowe: Znaki wielobajtowe w tekście komentarza COBOL muszą być zgodne z regułami określonymi w dokumentacji języka Enterprise COBOL dla znaków wielobajtowych.
Problemy związane z globalizacją: Treść wierszy komentarzy języka COBOL powinna być zgodna z regułami języka Enterprise COBOL w wersji 3.4 i nowszych. Proces generowania EST nie podejmuje żadnych prób manipulowania, transformowania ani tłumaczenia treści (poza tym, co opisano w tej sekcji) .
Niepoprawne punkty kodowe XML: Jeśli w komentarzach COBOL występują niepoprawne punkty kodowe XML 1.0 , a struktura copybook jest udostępniana narzędziom pojedynczej usługi na potrzeby przetwarzania, wówczas zachowanie narzędzia jest nieprzewidywalne (przykładem niepoprawnej treści XML jest znak o kodzie zero (0x00)).