Добавление комментариев в код

src/main/java/ru/cft/task/restClient/ConfigController.java

@@ -12,7 +12,7 @@ public class ConfigController {
     private Properties props;
     private InputStream conf_file = null;
     private OutputStream save_file = null;
-    private static final String CONF_FILE = "config.properties";
+    private static final String CONF_FILE = "config.properties";    // Имя файла конфигурации
 
     @FXML
     private TextField url;
@@ -31,6 +31,7 @@ public class ConfigController {
         props = new Properties();
         try {
             File cf = new File(CONF_FILE);
+            // Если файл не существует создадим пустой
             if (!cf.exists()) {
                 cf.createNewFile();
                 Utils.showAlert("warn", "Нет сохраненного файла настроек.\n" +
@@ -38,6 +39,7 @@ public class ConfigController {
                         "Необходимо изменить и сохранить.");
             }
             conf_file = new FileInputStream(CONF_FILE);
+            // Прочитаем данные из файла, если пусто то установим по умолчанию
             props.load(conf_file);
             url.setText(props.getProperty("url", "http://localhost"));
             port.setText(props.getProperty("port", "8080"));
@@ -54,6 +56,7 @@ public class ConfigController {
         }
     }
 
+    // Сохранение конфигурации
     public void saveAction() {
         try {
             save_file = new FileOutputStream(CONF_FILE);

src/main/java/ru/cft/task/restClient/EmailRecord.java

@@ -1,9 +1,10 @@
 package ru.cft.task.restClient;
 
+// Класс описывающий данные с сервера
 public class EmailRecord {
-    private long id;
-    private String name;
-    private String email;
+    private long id;        // id записи
+    private String name;    // Имя
+    private String email;   // почта
 
     public EmailRecord() {
     }

src/main/java/ru/cft/task/restClient/ErrorResponse.java

@@ -1,5 +1,6 @@
 package ru.cft.task.restClient;
 
+// Класс описания возвращаемой сервером ошибки
 public class ErrorResponse {
     private int errorCode;
     private String message;

src/main/java/ru/cft/task/restClient/Main.java

@@ -11,6 +11,7 @@ public class Main extends Application {
         launch(args);
     }
 
+    /* Создание главного окна приложения */
     public void start(Stage stage) throws Exception {
         Parent root = FXMLLoader.load(getClass().getResource("/main_app.fxml"));
         Scene scene = new Scene(root);

src/main/java/ru/cft/task/restClient/MainController.java

@@ -38,6 +38,7 @@ public class MainController {
         System.exit(0);
     }
 
+    /* Создание модального окна из ресурса */
     private void showModal(String fxml, String title) {
         Stage stage = null;
         try {
@@ -55,22 +56,27 @@ public class MainController {
         }
     }
 
+    // Окно настроек сервера
     public void showServerConfig() {
         showModal("/config.fxml", srv_config.getText());
     }
 
+    // Форма добавления записи
     public void createAction() {
         showModal("/form_create.fxml", create.getText());
     }
 
+    // Форма поиска записи
     public void readAction() {
         showModal("/form_read.fxml", read.getText());
     }
 
+    // Форма изменения записи
     public void updateAction() {
         showModal("/form_update.fxml", update.getText());
     }
 
+    // Форма удаления записи
     public void deleteAction() {
         showModal("/form_delete.fxml", delete.getText());
     }

src/main/java/ru/cft/task/restClient/RestActionsController.java

@@ -30,6 +30,7 @@ public class RestActionsController {
     @FXML
     private Button cancel;
 
+    // Получение пути до сервера из файла конфигурации
     private String getRestServerUrl() {
         Properties props = new Properties();
         InputStream conf_file = null;
@@ -53,6 +54,7 @@ public class RestActionsController {
         }
     }
 
+    // Метод для создания или обновления записи (различие только в типе запроса и id)
     private void createOrUpdate(HttpMethod method, MultiValueMap<String, String> params) {
         RestTemplate restTemplate = new RestTemplate();
         HttpHeaders headers = new HttpHeaders();
@@ -82,6 +84,7 @@ public class RestActionsController {
         stage.close();
     }
 
+    // Создание новой записи
     public void createAction() {
         MultiValueMap<String, String> map = new LinkedMultiValueMap<String, String>();
         map.add("name", name.getText());
@@ -89,6 +92,8 @@ public class RestActionsController {
         createOrUpdate(HttpMethod.POST, map);
     }
 
+    // Поиск записи по одному из параметров
+    // Приоритеты в порядке id -> email -> name
     public void readAction() {
         RestTemplate restTemplate = new RestTemplate();
         HttpHeaders headers = new HttpHeaders();
@@ -122,6 +127,7 @@ public class RestActionsController {
         }
     }
 
+    // Изменение записи
     public void updateAction() {
         MultiValueMap<String, String> map = new LinkedMultiValueMap<String, String>();
         map.add("id", id.getText());
@@ -130,6 +136,7 @@ public class RestActionsController {
         createOrUpdate(HttpMethod.PUT, map);
     }
 
+    // Удаление записи
     public void deleteAction() {
         RestTemplate restTemplate = new RestTemplate();
         HttpHeaders headers = new HttpHeaders();

src/main/java/ru/cft/task/restClient/Utils.java

@@ -8,6 +8,7 @@ import javafx.stage.Stage;
 
 import java.io.IOException;
 
+// Статические методы для общего пользования
 public class Utils {
     public static void showAlert(String type, String message) {
         Alert.AlertType alertType;