Code Monkey home page Code Monkey logo

Comments (4)

nin-jin avatar nin-jin commented on June 14, 2024

Или такой вариант:

$my_app $mol_book

    title \Hello World
        # \Text that displayed in window title. Should be non empty.

    books /
        
        <= Greetings $mol_page
            # \Page with greetings of current user. Displayed only at first start.
            
            body /
                <= greetings \Hello, {username}!
                    # \Greetings texts. Markdown supported.

from mam_mol.

osv avatar osv commented on June 14, 2024

Аннотации должни стимулировать их делать и бить понятные при скрининге текста. Древовидность проще реализовать но делает нагрузку на восприятие. Плюс в примере вводить специальный символ #

Что если сделать соглашение для коментариев. Как пример, если начинаеться из названия метода, то он и будет аннотацией.

$my_app $mol_book
	- title - Text that displayed in window title. Should be non empty.
	title \Hello World
	books /
		- Greetings - Page with greetings of current user. Displayed only at first start
		<= Greetings $mol_page
			body /
				- greetings - Greetings texts. Markdown supported.
				<= greetings \Hello, {username}!

$my_app $mol_book
	- title - Text that displayed in window title. Should be non empty.
	- Greetings - Page with greetings of current user. Displayed only at first start
	- greetings - Greetings texts. Markdown supported.
	title \Hello World
	books /
		<= Greetings $mol_page
			body /
				<= greetings \Hello, {username}!

При этом игнорируеться местоположние комментария в дереве.
Что позволяет также отделить документацию от реализации.

	- foo - describtion for propery foo
	- a1 - method a1
	- a2 - method a2
	- a3 - method a3
		more describtion for a3 
	foo <= a1 <= a2 <= a3 \3333

from mam_mol.

nin-jin avatar nin-jin commented on June 14, 2024

Документация и комментарии - это всё же разные вещи. Во многих языках документацию вставляют в комментарии лишь от безысходности. В Python, например, есть специальный синтаксис для документации.

Если сильно разносить, то проще прямо в readme и писать.

from mam_mol.

osv avatar osv commented on June 14, 2024

Да, не документация, а аннотации которые могли б быть в одном месте и отделены от реализации, покрайней мере мне это видеться удобным.

Аннотации в view.tree могли б

  • перекочевать в сгенерированый ts файл.
  • если будет language server то ему проще брать из исходника, но не с readme.

Идея выше, слегка похоже на jsdoc. Только максимально простая, в примере паттерн для выявления аннотации (?<methodName>\w+) - , но может быть и другой

from mam_mol.

Related Issues (20)

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.