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

cmd/fight_club/fighter/fighter.go

@@ -54,12 +54,14 @@ func getRandomByte(n ...int) byte {
 	return byte(rand.Intn(max))
 }
 
+// Возвращает случайное имя бойца
 func ChooseRandomFighterName() string {
 	rand.Seed(time.Now().UnixNano())
 	var max int = len(names)
 	return names[rand.Intn(max)]
 }
 
+// Возвращает список из имен, которые выбраны случайным образом
 func GetRandomNames(count int) []string {
 	rand.Seed(time.Now().UnixNano())
 

cmd/fight_club/fighter/fighting.go

@@ -17,7 +17,6 @@ type Punch struct {
 
 // Загружает список приемов и их урон из json файла со структурой
 // `[{"name": "p_name_1", "damage": 5},{"name": "p_name_2", "damage": 8}]`
-
 func loadPunches(filname string) []Punch {
 	cont, err := ioutil.ReadFile(filname)
 	if err != nil {
@@ -35,7 +34,8 @@ func loadPunches(filname string) []Punch {
 	return punches
 }
 
-// Возвращает победителя.
+// Устраивает драку.
+// Бойцы бьют друг друга по очереди, пока у них есть здоровье.
 func StartFight(firstFighter, secondFighter *Fighter) *Fighter {
 	var winner *Fighter
 	var choice int
@@ -67,7 +67,8 @@ func StartFight(firstFighter, secondFighter *Fighter) *Fighter {
 	return winner
 }
 
-//  Выбор приема на основе характеристики
+// Выбор приема на основе характеристики.
+// Генерируется случайным образом от 0 до punchCharacteristic
 func choosePunch(punchCharacteristic byte, punchList []Punch) int {
 	var choice int
 
@@ -81,7 +82,7 @@ func choosePunch(punchCharacteristic byte, punchList []Punch) int {
 
 }
 
-// Боец получает удар
+// Боец получает удар, теряет здоровье
 func (f *Fighter) getPunch(punch *Punch) {
 	if punch.Damage > int(f.health) {
 		f.health = 0

cmd/fight_club/fighter/names.go

@@ -1,3 +1,4 @@
+// Функции для генерации списка имен, из которого потом будем выбирать имена бойцов.
 package fighter
 
 import (

cmd/fight_club/main.go

@@ -5,8 +5,7 @@ import (
 	"fmt"
 )
 
-// Главный модуль. Просит выбрать бойца.
-
+// Главный модуль. Просит выбрать бойца, начинает драку.
 func main() {
 	var res int
 

readme.org

@@ -1,7 +1,7 @@
 #+title: Кто победит?
 
 * Что это?
-В нашем реалме недавно запретили все виды соревновательных боев (даже улиточные бои!). Поэтому, мы с друзьями решили попробовать сделать заменитель. Так как заперт касается только физических форм жизни (они могут получить урон), мы решили сделать бои джинов.
+В нашем реалме недавно запретили все виды соревновательных боев (даже улиточные бои!). Поэтому, я решил сделать заменитель. Так как запрет касается только физических форм жизни (они могут получить урон), мы решили сделать бои джинов.
 
 К счастью, в наше время джины стали маленькие и безобидные. Им самим весело друг с другом соревноваться, ведь боли они не чувствуют.