ivan-igorevich
/
gb-java-devel
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

more javadoc params, going to gdrive

This commit is contained in:
Ivan I. Ovchinnikov 2022-08-16 22:53:22 +03:00
parent c1e59dea83
commit d544e5323f
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -10,3 +10,4 @@
!/build/*.pdf !/build/*.pdf
!/*/build/*.pdf !/*/build/*.pdf
Icon*

BIN
build/j-spec.pdf
View File

Binary file not shown.

19
j-spec.tex
View File

@ -12,7 +12,7 @@
\usepackage{enumitem} \usepackage{enumitem}
\usepackage{multicol,multirow} \usepackage{multicol,multirow}
\usepackage{float,adjustbox} \usepackage{float,adjustbox}
%\usepackage{fontawesome} \usepackage{fontawesome}
\usepackage{longtable} \usepackage{longtable}
\usepackage{tikz} \usepackage{tikz}
\usepackage{hyperref} \usepackage{hyperref}
@ -53,8 +53,8 @@
\lhead{\includegraphics[height=5mm]{logo.png}} \lhead{\includegraphics[height=5mm]{logo.png}}
\rhead{И.И. Овчинников \\ \href{https://t.me/ivanigorevichfeed}{Telegram: ivanigorevichfeed}} \rhead{И.И. Овчинников \\ \href{https://t.me/ivanigorevichfeed}{Telegram: ivanigorevichfeed}}
\chead{\thepage} \chead{\thepage}
% \cfoot{\faRocket} \cfoot{\faRocket}
% \rfoot{Всего слов: \wordcount} \rfoot{Всего слов: \wordcount}
} }
\geometry{ \geometry{
@ -358,11 +358,20 @@ Here is your number: 4.
\item \code{-docencoding} кодировка конечной сгенерированной документации. \item \code{-docencoding} кодировка конечной сгенерированной документации.
\end{itemize} \end{itemize}
Чаще всего в комментариях используются следующие ключевые слова:
\begin{itemize}
\item \code{@param} описание входящих параметров
\item \code{@throws} выбрасываемые исключения
\item \code{@return} описание возвращаемого значения
\item \code{@see} где ещё можно почитать по теме
\item \code{@since} с какой версии продукта доступен метод
\item \code{{@code "public"}} вставка кода в описание
\end{itemize}
\subsection*{Задания к семинару} \subsection*{Задания к семинару}
\begin{itemize} \begin{itemize}
\item Скомпилировать проект из трёх классов, находящихся в двух пакетах, а также создать для этого проекта стандартную веб-страницу с документацией \item Создать проект из трёх классов (основной с точкой входа и два класса в другом пакете), которые вместе должны составлять одну программу, позволяющую производить четыре основных математических действия и осуществлять форматированный вывод результатов пользователю.
\item Скомпилировать проект, а также создать для этого проекта стандартную веб-страницу с документацией ко всем пакетам.
\end{itemize} \end{itemize}
\subsection*{Сценарий лекции} \subsection*{Сценарий лекции}
%\subfile{scenarios/jc-1-c} %\subfile{scenarios/jc-1-c}