Написать комментарий к файлу класса: Java

Question

Возможно ли вручную написать в файле класса или API, который может, если да, как это сделать?

Answer 1

Файл класса java - это файл, содержащий скомпилированный байт-код Java. Таким образом, нет практического способа вручную отредактировать этот файл. Комментарии обычно помещаются в исходный код, чтобы сообщить разработчикам, для чего нужен определенный раздел кода и/или что он делает и почему. Поскольку человек не может (практически) напрямую редактировать файл класса или читать его, нет никаких оснований добавлять комментарии к нему. Когда исходный файл скомпилирован в байт-код из Java, комментарии не компилируются в байт-код. Поэтому даже если вы можете вручную отредактировать файл, нет возможности добавить к нему комментарии.

Answer 2

Файл .class является .java файл после того, как он был собран.

Когда файл скомпилирован, создается только функциональный код, комментарии разделяются.

Нет синтаксиса, который позволит вам иметь комментарии в файле .class, который по-прежнему будет функционировать впоследствии.

Answer 3

Как и большинство людей, файл .class является скомпилированным файлом .java, и только JVM может его прочитать. Но вы можете поместить // в начале любой строки, чтобы создать комментарий в его части .java. Я даже не думаю, что можно сделать комментарий в .class из-за того, что его в основном UTF-8 символов (которых я действительно не получаю). Вот пример:

class YourClass{ public static void main(String[] args){ //comment line System.out.println("normal line"); } }

Это, по крайней мере, как я делать такие вещи, как это.

Answer 4

Вы не должны ничего писать в файле .class. Файл класса написан командой javac и не будет содержать никаких комментариев, сделанных вами в вашем .java-файле. Файл .class предназначен только для JVM, и JVM не заботится о комментариях.

Answer 5

Нет стандартного способа поместить комментарии в файл класса, потому что это не то, что люди обычно должны делать.

Однако, если вы просто хотите приклеить текстовые метаданные внутри файла класса, по какой-то причине есть много мест. Спецификация JVM определяет множество мест, где вы можете добавлять собственные метаданные. Вы даже можете сделать его видимым для кода во время выполнения, создав аннотацию времени выполнения.

Answer 6

Как я понимаю, вы спрашиваете о комментариях на Java. Есть три вида комментариев в Java:

/* text */: comment detail in the "text" and compiler does not compile everything from /* to */. 

/** documentation */: A kind of documentation comment(doc comment, explain a complex business in code). The compiler ignores this as the text comment form /* and */. More detail you can search in Java doc. 

// text 
    The compiler ignores everything from // to the end of the line.