Comments (4)
Или такой вариант:
$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.
Аннотации должни стимулировать их делать и бить понятные при скрининге текста. Древовидность проще реализовать но делает нагрузку на восприятие. Плюс в примере вводить специальный символ #
Что если сделать соглашение для коментариев. Как пример, если начинаеться из названия метода, то он и будет аннотацией.
$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.
Документация и комментарии - это всё же разные вещи. Во многих языках документацию вставляют в комментарии лишь от безысходности. В Python, например, есть специальный синтаксис для документации.
Если сильно разносить, то проще прямо в readme и писать.
from mam_mol.
Да, не документация, а аннотации которые могли б быть в одном месте и отделены от реализации, покрайней мере мне это видеться удобным.
Аннотации в view.tree могли б
- перекочевать в сгенерированый ts файл.
- если будет language server то ему проще брать из исходника, но не с readme.
Идея выше, слегка похоже на jsdoc. Только максимально простая, в примере паттерн для выявления аннотации (?<methodName>\w+) -
, но может быть и другой
from mam_mol.
Related Issues (20)
- $mol_pick_time - user friendly time picker HOT 5
- Not able to use spread when destructuring object HOT 4
- mam для разработки бекенда HOT 6
- демо drag/demo не работает в мобильном браузере HOT 1
- Cache-Control: no-cache для test.html HOT 4
- $mol_attach port to $mol_gallery
- $mol_book2_demo: add descriptions
- Лапша из репозиториев HOT 9
- Фейлится сборка, если в пути к папке проекта есть пробелы HOT 2
- Ссылка сливается с общим фоном инструкции HOT 1
- Bug with button showcase HOT 1
- $mol_tag_tree: automatic taxonomy by tags HOT 2
- Возможность делать снепшот документации и восстанавливать кэш браузера из нее
- На главной оставить только несколько ссылок
- $mol_date improvements HOT 1
- В viewtree не прорастают дефолтные методы из массивов, если явно не заданы в корне
- Translation license problem HOT 1
- Маркетинг слишком токсичный, идеи в фреймворке интересные. HOT 2
- Unexpected behavior of $mol_tree2_to_json HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mam_mol.