სად დავდო Javadoc კომენტარები?
სად დავდო Javadoc კომენტარები?
Anonim

The javadoc კომუნალური პროგრამა გაძლევთ საშუალებას დადება შენი კომენტარები თქვენი კოდის გვერდით, თქვენს შიგნით. ჯავა წყარო ფაილები. როცა კმაყოფილი ხართ თქვენი კოდით და კომენტარები , თქვენ უბრალოდ აწარმოებთ javadoc ბრძანება და თქვენი HTML სტილი დოკუმენტაცია ავტომატურად იქმნება თქვენთვის.

შემდეგ, როგორ დაამატებთ კომენტარები Javadoc-ს?

გამოყენებისას გაითვალისწინეთ შემდეგი დაამატეთ Javadoc კომენტარი (Alt+Shift+J): რათა დაამატეთ ა კომენტარი ველში, მოათავსეთ კურსორი ველის დეკლარაციაზე. რომ დაამატეთ ა კომენტარი მეთოდზე მოათავსეთ კურსორი მეთოდის ნებისმიერ ადგილას ან მის დეკლარაციაზე.

რა სარგებლობა აქვს Javadoc-ის კომენტარებს? ჯავადოკი არის ინსტრუმენტი, რომელიც მოყვება JDK-ს და არის გამოყენებული გენერირებისთვის ჯავა კოდის დოკუმენტაცია HTML ფორმატში ჯავა წყაროს კოდი, რომელიც მოითხოვს დოკუმენტაციას წინასწარ განსაზღვრულ ფორმატში. ქვემოთ მოცემულია მარტივი მაგალითი, სადაც ხაზები შიგნით /*…. */ არიან ჯავა მრავალხაზოვანი კომენტარები.

აქედან, სად დავაყენო Javadoc?

თქვენ შეგიძლიათ განათავსოთ JavaDoc კომენტარები წყაროს ფაილში სამი სხვადასხვა ადგილას:

  1. საჯარო კლასის გამოცხადებამდე უშუალოდ.
  2. საჯარო სფეროს გამოცხადებამდე უშუალოდ.
  3. საჯარო მეთოდის ან კონსტრუქტორის გამოცხადებამდე უშუალოდ.

როგორ დავწერო Javadoc კომენტარები Intellij-ში?

3 პასუხი. შეიქმნება მეთოდის ხელმოწერის აკრეფა /** + და დააჭირეთ Enter-ს ზემოთ ჯავადოკი ნაკვთები თქვენთვის. Შენ შეგიძლია გამოყენება ქმედება „შეასწორე დოკუმენტი კომენტარი '. მას არ აქვს ნაგულისხმევი მალსახმობი, მაგრამ შეგიძლიათ Alt + Shift + J მალსახმობი მიანიჭოთ Keymap-ში, რადგან ეს მალსახმობი სხვა არაფერში არ გამოიყენება.

გირჩევთ: