Giter Club home page Giter Club logo

java-school-2022-exmpl's Introduction

java-school-2022-exmpl

Меркушин Денис https://t.me/illitain

Этот проект - пример структуры проекта для выполнения домашнего задания в рамках Java школы 2022 года от КРОК. Основные моменты:

  1. В проекте должен быть readme.md-файл, в котором должна быть информация об авторе (имя, фамилия. Ник в телеграме по желанию)
  2. Структура проекта - согласно примеру. Код лежит в папке src в пакетах ru.croc, где уже находятся пакеты каждой из задач (taskN). То есть решение каждой задачи - в своем пакете.
  3. При написании кода не забывайте о правилах кодирования на Java! Основные моменты перечислю сам:
    • Обращайте внимание на названия классов, атрибутов и методов, а также имена переменных. Все они должны быть информативны и понятны.
      • По классам - название основных классов (с main-методом) должно соответствовать шаблону: TaskN, где N - номер задачи
    • В одной строке не должно быть большое количество операторов. В идеале - один оператор на строку, последующие - переносите на новые.
    • ИНФОРМАТИВНЫЕ комментарии (особенно если где-то неуверены, сами понимаете, что пишите запутанный код и/или из нескольких альтернатив реализации выбрали что-то конкретное - прям пишите что рассматривали, что выбрали и почему).

P.S. В интернете много информации о правилах кодирования на Java. В целом, первая ссылка гугла по большей части описывает неплохо, хотя я лично привык переносить длинные строки не в формате

int result = function1(longExpression1,
function2(longExpression2,
longExpression3));

А в формате:

int result = function1(
   longExpression1,
   function2(
      longExpression2,
      longExpression3
   )
);

java-school-2022-exmpl's People

Contributors

illitain avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.