В VS Code теперь документацию пишет ИИ — разработчики хвалят

Команда стартапа Mintlify выпустила ИИ-расширение VS Code для создания документации. Инструмент, по словам создателей, преследует только одну цель — автоматизировать один из самых скучных и нелюбимых процессов среди разработчиков. Если вам тоже надоело писать документацию, продолжайте читать. 

«Как много вы знаете разработчиков, которые любят писать документацию? Некоторые понимают ее ценность и будут составлять ее с неохотой, но вряд ли кто-то получает от этого процесса настоящее удовольствие», — такими мыслями руководствовались разработчики Mintlify, когда создавали инструмент под названием AI Doc Writer для VS Code. 

Как пользоваться

Расширение установили уже почти шесть тысяч раз. На данный момент оно поддерживает следующие языки программирования: 

• Python;
• JavaScript, а также JSX- и TSX-файлы;
• TypeScript;
• PHP,
• Java.

Чтобы сгенерировать документацию, достаточно выделить код или поместить курсор на строку, которую нужно задокументировать. Затем нажать на кнопку Generate Docs (или CMD/CTRL + .), после чего инструмент автоматически создаст документацию для функции. Вот как это выглядит:

Стоит отметить, что пока расширение совместимо только с редактором VS Code, но, по словам создателей, в скором времени планируется поддержка IntelliJ, а также других IDE и платформ. Вы можете установить AI Doc Writer по ссылке. 

Насколько хорошо ИИ анализирует и описывает код

Для ответа на этот вопрос обратимся к примеру ниже. На нем: команда Mintlify опубликовала пример:

class Grammar():
    def __init__(self, rules):
        self.rules = rules

А вот как он будет выглядеть с документацией, которая была создана с помощью AI Doc Writer.

class Grammar():
    def __init__(self, rules):
        """
        Probabilistic Context Free Grammar (PCFG) over program expressions
        rules: mapping from non-terminal symbol to list of productions
        each production is a tuple of (log probability, form)
        where log probability is a float corresponding to the log of the probability that 
        generating from that nonterminal symbol will use that production
        form is either 
          : a tuple of the form (constructor, non-terminal-1, non-terminal-2, ...). 
          `constructor` should be a component in the DSL, such as '+' or '*', which takes arguments
          : just `constructor`, where `constructor` should be a component in the DSL, 
          such as '0' or 'x', which takes no arguments        
        non-terminals can be anything that can be hashed and compared for equality, such as strings, 
        integers, and tuples of strings/integers
        """
        self.rules = rules

По словам создателей инструмента, без документации было бы практически невозможно понять тип/структуру свойств rules.

По мнению разработчиков, которые уже опробовали инструмент в действии, AI Doc Writer способен сэкономить много времени айтишникам, а также повысить качество и читабельность кодовых баз. И, наверное, самое главное, как и заявляют создатели, сделать процесс написания документации проще и менее утомительным.

Ранее мы писали об инструменте от Alphabet, который основан на искусственном интеллекте и генерирует код на Python и C++.