Comments (4)
Counterpoint, the asterisks add a lot of visual noise that could be avoided by blocks of single-line comments, like those most commonly used by Rust for docstrings.
/// This is my documentation for a struct [`ABC`]
struct ABC {
/// This is my documentation for [`x`]
x: u32,
}
from neva.
I don't see a reason why multi-line comments are needed for now
from neva.
Honestly I intentionally didn't add it because I failed to see why need it. I personally never use this.
There's a shortcut for //
in any IDE which isn't the case for multi-line comment. Also bunch of one-liners can do the same thing. E.g. I think I almost never see multi-line comments in Go, even tho sometimes comment sections are very big.
Could you please describe your opinion on this? What is the use case for multiple-comment? What it adds that's impossible with //
?
from neva.
Ive been thinking a lot about how automatic documentation should work and how we could implement it, this all started because of #620 (which I think we should implement as the basis for the documentation website)
Heres how it could look
/*Description:
Comp description of what it does etc
/*Authors:
Authors of component
/*
/*Examples:
Examples of the comp
/*
// and more
component Foo(start any) (sig any){
// Component definition
}
This should also be plugged into the LSP
from neva.
Related Issues (20)
- Cancelation Problem HOT 2
- [Desugarer] original unnamed DI arg is still there after desugaring HOT 1
- Userland Buffers Via STDlib Flows (Components)
- Can't compile without strict typing of inport HOT 2
- Runtime Algorithm HOT 4
- `Index` flow has a generic signature that doesn't make sense.
- `$const` can fill the buffer real quick HOT 4
- Remove all initialization related error handling from runtime
- Remove usage of `cfg` message from `Field` component HOT 1
- [STD] Separate "internal" components from just "global scope" ones
- Get rid of "Configuration Message" abstraction
- Should `Range` have `err` outport?
- Overloaded `For`?
- Even more sugar for static inports (constant senders)
- Out of Order Delivery HOT 1
- Non-blocking `For` HOT 2
- Ternary/if-then-else as HOCs HOT 1
- Lowercase components names?
- Use Uppercase for export like Go
- Race-free Parallel Connections HOT 2
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 neva.