RAP – ABAPDoc Yorumu Oluşturma

ABAPDoc yorumları kodunuzu belgelemek için kullanılır. Bu kodu daha okunabilir hale getirir. Nesnelerden biri kullanılmak istendiğinde, kodda nesne adını seçip Element Info (F2) seçeneğini belirleyerek nesne hakkında daha fazla bilgi edinilebilir.

Tüm ABAPDoc yorumları “! ile başlar 


Step 1: ABAP Sınıfında ABAPDoc Oluşturma – Paragraph
  1. Sınıf tanımından hemen önce, “! seçeneğini belirleyerek sınıfa bir ABAPDoc yorumu eklenir. (Ctrl+Space)
  2. Açılır listeden “Paragraph” seçilir, ardından aşağıdaki yorumu eklenir;

Not: ABAPDoc yorumunu immediately hemen önce eklemelisiniz ; aksi takdirde ADT’den uyarı alırsınız.

  1. <p> Paragraph etiketine şunu ekleyin : class=”shorttext synchronized”, böylece kodunuz şu şekilde görünür:
"! <p class="shorttext synchronized" lang="en">Yöntem AMDP kullanarak HANA DB'den uçuşları okur</p>

Sonuç:


Step 2: ABAPDoc Oluşturma – Sorted List
  1. Sınıf tanımından hemen önce, “! seçeneğini belirleyerek sınıfa bir ABAPDoc yorumu eklenir. (Ctrl+Space)
  2. Açılır listeden “Sorted list” seçilir, ardından aşağıdaki yorumu eklenir;
"! <ol>
"!    <li>JSON Serialize işlemini yapar</li>
"!    <li>JSON yapısını structure yapısına dönüştürür</li>
"! </ol>


3. Sorted list işleminden sonra Enter’a basılır ve aşağıdaki yorum eklenir;

"! <p>Implements the interface { @link INTF: if_oo_adt_classrun } </p>


4. Sınıfınızı seçin ve Kod öğesi bilgilerini göster (F2) seçeneğini belirleyin.


Arayüze giden bağlantıyı seçerseniz, dokümantasyonu görüntülenir.(if_oo_adt_classrun)


İletişim

Bir yanıt yazın

E-posta adresiniz yayınlanmayacak. Gerekli alanlar * ile işaretlenmişlerdir