Диаграммы ASCII стоят моего времени? - PullRequest
Новая
       29

Диаграммы ASCII стоят моего времени?

18 голосов
/ 26 апреля 2010

Стоят ли диаграммы ASCII в исходном коде времени, которое они тратят на создание?

Я мог бы создать растровую диаграмму гораздо быстрее, но изображения в исходном файле намного сложнее ( до VS2010 ).

Кстати, я не говорю о декоративном искусстве ASCII .

Вот пример диаграммы, которую я недавно создал для своего кода, которую я, вероятно, мог бы построить за половину времени в MS Paint. 

          Scenario A:

                          v
 (U)____________(N)_______<--(P)                   Legend:
          '     /             |                    J = ...
          '    /              |                    P = ...
          '   /d              |                    U = ...
          '  /                |                    v = ...
          ' /                 |                    d = ...
          '/                  |                    N = ...
         (J)                  |
          |                   |
          |___________________|

Ответы [ 12 ]

0 голосов
/ 22 ноября 2013

Я собрал список ссылок и небольшой учебник для рисования диаграмм ASCII на Python Wiki . Любые картинки, которые экономят ваше время на чтение текста, безусловно, стоят того.

0 голосов
/ 26 апреля 2010

Я согласен с большинством других постеров: все, что не является кодом (и небольшим количеством комментариев, но не слишком многословным), должно быть где-то еще, будь то вики или документ.

Я бы предпочел избегать Word из-за различных неудач, с которыми я столкнулся в прошлом, но это могло быть личным предпочтением. Еще одна вещь: старайтесь иметь хорошие имена для вещей и используйте их как ссылку между вашим кодом и вашими документами. Поэтому, если у вас есть класс (или подпрограмма, или модуль), который имеет дело со сценариями, подобными тому, который вы показали в качестве примера, пожалуйста, назовите его SquareBisector или что-то вроде этого, и его методы должны быть scriptA (точка a, точка b) , сценарий B (точка a, строка l1) и т. д., а затем запишите документы, объясняющие их в более общих терминах, с множеством диаграмм, в документе, используя согласованную терминологию.

Пожалуйста, не называйте ваши методы "bisectWithTwoPoints (Point firstPoint, Point secondPoint) в коде и" Сценарий A "в документации ...

Страница:
...