מבוא
הערות - נראה שזה יכול להיות פשוט יותר, ולמה לכתוב מאמר שלם. אבל זה לא כל כך פשוט. כמו שהבוס שלי אמר, כל אחד יכול לכתוב קוד, אבל לכתוב תגובה טובה זה קשה. רוב קורסי השפה מתחילים ב-Hello World המסורתי. אפילו ב- Oracle Tutorials, בסעיף "תחילת העבודה", אנחנו מתחילים עם "Hello World!" יישום . וכבר משורות הקוד הראשונות אנו רואים אותן - הערות Java. חשיבותם מודגשת גם על ידי העובדה שבמסמך כה חשוב כמו אמנת Java Code, ניתן להערות סעיף נפרד: הערות . על פי התיעוד, הערות ב-Java מחולקות לשני סוגים:- הערת יישום (או הערת קוד);
- הערה מתעדת.
הערות קוד Java
מהשם ברור שהערה זו מתייחסת לקוד וצריכה לשקף את תכונותיו. הערות הקוד הן:-
אותיות קטנות (כלומר מתואר בשורה אחת)
// Строчный комментарий System.out.println("Hello, World!");
-
בלוק (כלומר הם מתוארים כגוש שלם, כי הם לא מתאימים על קו אחד)
/* * Блочный комментарий */ System.out.println("Hello");
בכל פעם שאתה מגיב, תתכווץ ותרגיש כמו כישלון".ברור שאין אמת מוחלטת, ולפעמים יש צורך בהערות. אבל תמיד יש אפשרויות, וצריך להילחם בהערות מיותרות. פרק זה מזכיר גם הערות חריגות, TODO:
// TODO: Добавить World
System.out.println("Hello, ");
הנקודה בהם היא שניתן לטפל בהם בצורה מיוחדת ב-IDE. לדוגמה, ב-IDEA הם נאספים בלשונית נפרדת, שבה אתה יכול לראות אותם:
הערות לתיעוד
הערות תיעוד מתארות את ה-API הציבורי. API הוא ממשק תכנות היישומים, כלומר אותם מחלקות ושיטות הזמינות למפתחים אחרים לביצוע כל פעולה. בקיצור, ההערות הללו צריכות להסביר מדוע נוצרה מחלקה וחבילה זו או אחרת ומה עושה שיטה זו או אחרת. ניתן גם לתאר שדות כיתה במידת הצורך. זה בדיוק מה שאנחנו רואים בטיפים של ה-IDEs שלנו, המוצגים כ-JavaDoc. לדוגמה:package test;
/**
* This is a JavaDoc class comment
*/
public class JavaDocTest {
/**
* This is a JavaDoc public field comment
*/
public static final String HELLO_MESSAGE = "Hello, World!";
public static void main(String... args) {
JavaDocTest.greetings();
}
/**
* This is a JavaDoc public method comment
*/
public static void greetings() {
System.out.println(HELLO_MESSAGE);
}
}
לאחר מכן, נוכל להריץ את הפקודה הבאה מהספרייה המכילה את ספריית החבילות שלנו: javadoc -d ./test test
לאחר מכן, נראה את תהליך יצירת התיעוד.
סיכום
כפי שאנו יכולים לראות, דבר כל כך פשוט לכאורה כמו הערות מתברר כהרבה יותר מסובך במציאות. לכן, אם תבזבז זמן מה על הערות ותעקוב אחריהם, הקוד שלך יהיה טוב יותר ותהיה לך ערך רב יותר כמתכנת. #ויאצ'סלבמה עוד לקרוא: |
---|
GO TO FULL VERSION