Регистрация Войти
Рейтинг:0
avatar Ubuntu

Справка по параметрам функций

флаг jp
Fatipati

Я пишу документацию для функции bash, которую я пишу. Он поддерживает параметр цвета, который может быть одним из --vlt --blu --grn --ylw --orn --pur --red --wht. Я использовал следующее описание, но не уверен, что оно будет достаточно понятным, и хотел бы улучшить эту описательную справку.

 --ЦВЕТ
   Вариант цвета
 
   --COLR Краткое | --Краткий обзор COLR
   --+----------------
   --vlt Фиолетовый | --оранжевый
   --blu Синий | --пур Фиолетовый
   --grn Зеленый | --красный Красный
   --ylw Желтый | --wht белый
41
0 + 0
Artur Meinild avatar
флаг vn
Artur Meinild
Я считаю, что это будет в значительной степени основано на личном мнении и, следовательно, не по теме здесь. Я бы посоветовал вам провести опрос среди тех, кому следует прочитать документацию и узнать их мнение. Ваше здоровье!
0
Ответить
флаг jp
Fatipati
Существуют ли какие-либо программы командной строки, которые делают такой список таблиц опций?
0
Ответить
terdon avatar
флаг cn
terdon
Я уверен, что будет. Каждый автор программы волен делать все, что ему заблагорассудится в своих вариантах. Но поскольку на самом деле это не вопрос об Ubuntu, я согласен с Артуром, что это не по теме. Лично я бы просто использовал параметр `--color`, который принимает значения (например, `--color blue`), а затем предоставляет список допустимых значений в справочном сообщении.
2
Ответить
Рейтинг:0
karel avatar Ubuntu
флаг sa
karel

Документацию по функциям bash было бы легче понять, если бы вы заменили двусмысленное слово «Краткий» более описательной фразой «Имя цвета». Если это руководство, которое вызывается с терминала человек команды, вы также можете улучшить читаемость, отформатировав первую строку жирным шрифтом, как это часто делается на страницах руководства.

--ЦВЕТ
  Вариант цвета

  --COLR Название цвета | --COLR Название цвета
  ------+--------------------
  --vlt Фиолетовый | --оранжевый
  --blu Синий | --пур Фиолетовый
  --grn Зеленый | --красный Красный
  --ylw Желтый | --wht Белый
0 + 0
флаг Moldova
Admin
Этот вопрос на других языках:

Ответить или комментировать

Большинство людей не понимают, что склонность к познанию нового открывает путь к обучению и улучшает межличностные связи. В исследованиях Элисон, например, хотя люди могли точно вспомнить, сколько вопросов было задано в их разговорах, они не чувствовали интуитивно связи между вопросами и симпатиями. В четырех исследованиях, в которых участники сами участвовали в разговорах или читали стенограммы чужих разговоров, люди, как правило, не осознавали, что задаваемый вопрос повлияет — или повлиял — на уровень дружбы между собеседниками.