Rumah Java javaTutorial Java基础入门随笔(9)JavaSE版——文档注释

Java基础入门随笔(9)JavaSE版——文档注释

Dec 22, 2016 pm 01:15 PM

上节中写了一些static变量以及静态的方法的定义使用以及与非静态的差别,这节补充下:

如果在一个类中所有方法都为静态的,且无成员变量,这时候需要对对应的类进行限制该类无法创建对象,具体操作如下:

PRivate ArrayTool(){}

//该类中的方法都是静态的,所以该类是不需要的创建对象的。为了保证不让其他成创建该类对象,可以将该类的构造函数私有化。

1.文档注释

利用java虚假机中的javadoc工具进行文档注释生成,利用代码中的文档注释进行生成。

注意:

    1、每个编译单元(类文件)都仅能有一个public class 
    2、public class的名称(包含大小写)必须和其类文件同名。 
    3、一个类文件(*.java)中可以不存在public class。

使用 javadoc 标记:

javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

 以上就是Java基础入门随笔(9)JavaSE版——文档注释的内容,更多相关内容请关注PHP中文网(www.php.cn)!


Kenyataan Laman Web ini
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

AI Hentai Generator

AI Hentai Generator

Menjana ai hentai secara percuma.

Alat panas

Notepad++7.3.1

Notepad++7.3.1

Editor kod yang mudah digunakan dan percuma

SublimeText3 versi Cina

SublimeText3 versi Cina

Versi Cina, sangat mudah digunakan

Hantar Studio 13.0.1

Hantar Studio 13.0.1

Persekitaran pembangunan bersepadu PHP yang berkuasa

Dreamweaver CS6

Dreamweaver CS6

Alat pembangunan web visual

SublimeText3 versi Mac

SublimeText3 versi Mac

Perisian penyuntingan kod peringkat Tuhan (SublimeText3)

Bagaimana untuk menganotasi fungsi PHP dengan ulasan dokumentasi? Bagaimana untuk menganotasi fungsi PHP dengan ulasan dokumentasi? Apr 11, 2024 pm 04:48 PM

Komen dokumentasi PHP digunakan untuk menganotasi fungsi dan mengandungi medan yang diperlukan berikut: perihalan, parameter (@param), dan nilai pulangan (@return). Medan pilihan termasuk: pengecualian (@throws), versi pengenalan (@sejak) dan contoh penggunaan (@example). Gunakan alat PHPDocumentor untuk menjana dokumentasi HTML untuk melihat fungsi beranotasi.

Kod komen dalam PHP Kod komen dalam PHP May 23, 2023 am 08:27 AM

Komen kod ialah peringatan teks yang ditambahkan oleh pengaturcara semasa menulis kod untuk memudahkan mereka dan pengaturcara lain membaca dan memahami kod tersebut. Dalam PHP, komen kod sangat diperlukan. Artikel ini akan memperkenalkan secara terperinci jenis, spesifikasi dan penggunaan komen kod dalam PHP. 1. Jenis komen kod dalam PHP Dalam PHP, terdapat tiga jenis ulasan: komen satu baris, komen berbilang baris dan komen dokumentasi. Komen satu baris Komen satu baris bermula dengan garis miring dua "//" dan berakhir pada penghujung baris. Contohnya: //Ini ialah ulasan satu baris ulasan berbilang baris ulasan berbilang baris yang berakhir dengan "

Hubungan pelengkap antara ulasan dokumentasi dan konvensyen penamaan dalam penamaan fungsi C++ Hubungan pelengkap antara ulasan dokumentasi dan konvensyen penamaan dalam penamaan fungsi C++ May 03, 2024 am 09:00 AM

Konvensyen penamaan fungsi dan ulasan dokumentasi dalam C++ saling melengkapi dan meningkatkan kebolehbacaan kod. Konvensyen penamaan memberikan nama fungsi yang jelas dan konsisten, manakala ulasan dokumentasi menambah butiran seperti tujuan, parameter, nilai pulangan dan prasyaratnya, memastikan kod itu mudah difahami, diselenggara dan dilanjutkan.

Pemula Java: Bagaimana untuk menentukan peringkat kemasukan? Pemula Java: Bagaimana untuk menentukan peringkat kemasukan? Feb 18, 2024 pm 06:29 PM

Bermula dengan Java: Pada Langkah Apa dalam Pembelajaran Adalah Pemula? Sebagai bahasa pengaturcaraan yang digunakan secara meluas dalam bidang pembangunan perisian, Java mudah dipelajari, merentas platform, dan sangat selamat, jadi ia sangat popular di kalangan pengaturcara. Ramai pemula berharap untuk memulakan Java secepat mungkin dan memulakan perjalanan pengaturcaraan mereka. Jadi, bagaimana kita menilai bahawa kita telah bermula dengan Java dan apakah langkah yang telah kita pelajari? Pertama sekali, kita perlu menjelaskan konsep: bermula tidak bermakna mahir. Bermula hanya melengkapkan pemahaman awal dan penguasaan bahasa Java Anda boleh

Prasyarat penting untuk mempelajari teknologi Java: memahami konsep teras dan alatan aplikasi Prasyarat penting untuk mempelajari teknologi Java: memahami konsep teras dan alatan aplikasi Jan 13, 2024 pm 03:02 PM

Pengetahuan penting untuk mempelajari teknologi Java: menguasai konsep utama dan alatan pembangunan, dan memerlukan contoh kod khusus Java ialah bahasa pengaturcaraan komputer yang digunakan secara meluas dalam bidang pembangunan perisian. Kuasanya terletak pada ciri merentas platform dan sokongan alat pembangunan yang kaya, menjadikan Java sebagai salah satu bahasa pengaturcaraan yang paling popular hari ini. Jika anda ingin mempelajari teknologi Java, menguasai beberapa konsep utama dan alatan pembangunan adalah penting. Artikel ini akan memperkenalkan anda kepada beberapa pengetahuan Java yang diperlukan dan menyediakan beberapa contoh kod khusus untuk membantu anda dengan lebih baik

Perkongsian kaedah pembelajaran yang cekap untuk pengetahuan teras JAVA Perkongsian kaedah pembelajaran yang cekap untuk pengetahuan teras JAVA Nov 08, 2023 pm 06:44 PM

JAVA ialah bahasa pengaturcaraan berorientasikan objek yang digunakan secara meluas dalam bidang pembangunan perisian. Menguasai dan mahir menggunakan pengetahuan teras JAVA adalah penting untuk pengaturcara Ia boleh meningkatkan kecekapan pembangunan dan menjadikan kod lebih dipercayai dan lebih mudah diselenggara. Artikel ini akan berkongsi beberapa kaedah untuk mempelajari pengetahuan teras JAVA dengan cekap dan memberikan contoh kod khusus. 1. Langkah asas untuk mempelajari pengetahuan teras JAVA Untuk mempelajari bahasa pengaturcaraan baharu, anda perlu menguasai sintaks dan ciri asasnya. Untuk JAVA, anda boleh membaca tutorial atau buku yang berkaitan

Spesifikasi Komen PHP: Cara menggunakan komen dokumentasi untuk menulis dokumentasi API Spesifikasi Komen PHP: Cara menggunakan komen dokumentasi untuk menulis dokumentasi API Jul 30, 2023 pm 07:00 PM

Spesifikasi Komen PHP: Cara menggunakan komen dokumentasi untuk menulis dokumentasi API Pengenalan: Apabila membangunkan aplikasi PHP, menulis dokumentasi API yang lengkap adalah sangat penting untuk pasukan pembangunan dan pembangun lain. Dokumentasi yang baik meningkatkan kebolehbacaan dan kebolehselenggaraan kod, serta menggalakkan kerja berpasukan dan perkongsian maklumat. Artikel ini akan memperkenalkan cara menggunakan ulasan dokumentasi untuk menulis dokumentasi API PHP dan menyediakan beberapa kod sampel untuk membantu pembaca memahami cara menulis ulasan dengan cara yang standard. Spesifikasi komen Dalam PHP, kami menggunakan komen untuk menerangkan dan menerangkan kod. secara amnya

Bagaimana untuk menjelaskan keperluan dan cadangan spesifikasi kod PHP terkini dalam dokumen projek dan ulasan dokumentasi? Bagaimana untuk menjelaskan keperluan dan cadangan spesifikasi kod PHP terkini dalam dokumen projek dan ulasan dokumentasi? Sep 05, 2023 pm 02:16 PM

Bagaimana untuk menjelaskan keperluan dan cadangan spesifikasi kod PHP terkini dalam dokumen projek dan ulasan dokumentasi? Pengenalan: Semasa pembangunan projek PHP, adalah sangat penting untuk mengikuti spesifikasi kod bersatu. Spesifikasi kod yang baik boleh meningkatkan kebolehbacaan dan kebolehselenggaraan kod, mengurangkan ralat pengekodan dan meningkatkan kecekapan kerjasama pasukan. Untuk memastikan kualiti kod projek, pasukan pembangunan perlu menjelaskan keperluan dan cadangan spesifikasi kod PHP terkini. Dalam artikel ini, kami menerangkan cara untuk membuat keperluan dan pengesyoran ini jelas dalam dokumentasi projek dan ulasan dokumentasi, digambarkan dengan contoh kod

See all articles