Comments (8)
This is expected. You are using C# syntax of XML tags in documentation comments. Use Ć syntax for documentation comments instead.
from fut.
Can you reopen this issue, I'm interested to fixing this in pull request because it seems a simple fix. Maybe if I could make it so that docs comments result in official docs comments for every language like JSDocs, Doxygen etc...
from fut.
What would you like to fix here? If you type <
in a Ć doc comment, it means you want to see <
in the generated documentation and therefore it needs to be escaped in C#, Java and Doxygen syntax.
from fut.
Hmmm, I don't understand you... This is docs comments created for C#, and for me this is wrong...
/// <summary><summary>
/// Pretvori šteilko v osmiški zapis.</summary>
/// <remarks></summary>
/// <param name="a">Cela številka v desetiškem zapisu.</param>
/// <returns>Cela številka v osmiškem zapisu.</returns></remarks>
from fut.
Just use Ć syntax, also for documentation comments (see the link above). cito
transpiles documentation comments as well.
C:\0\ci>cat ticket72.ci
public class Foo
{
/// Pretvori šteilko v osmiški zapis.
/// Returns cela številka v osmiškem zapisu.
public void Bar(
/// Cela številka v desetiškem zapisu.
int a)
{
}
}
C:\0\ci>cito -o ticket72.cs ticket72.ci
C:\0\ci>cat ticket72.cs
// Generated automatically with "cito". Do not edit.
public class Foo
{
/// <summary>Pretvori šteilko v osmiški zapis.</summary>
/// <remarks>Returns cela številka v osmiškem zapisu.</remarks>
/// <param name="a">Cela številka v desetiškem zapisu.</param>
public void Bar(int a)
{
}
}
from fut.
Ooooooohhhhhhh I see now what you did there, thank you for clarification, I didn't found this in the docs.
from fut.
Does this works for returning tag? return
from fut.
There is no support for the <returns>
tag. I'd love to have it added! That could be your first PR. Note that:
- It should be supported for all the target languages, not just C#.
- I'd prefer lightweight Markdown style and not some XML or JavaDoc tags. How about a doc comment line starting with the "Returns" word?
from fut.
Related Issues (20)
- WIP: Support for starting child processes and reading output
- Emit compiler directives based on language being compiled HOT 6
- Allow delegates / anonymous functions HOT 6
- Promise / Callback Types (Instead of async/await?) HOT 3
- String Comparisons HOT 1
- Revisiting ICU dependency HOT 4
- What is the ref-code in the Playground examples, if C/C++ were supposed to not have GC? HOT 23
- Is there some mailing list, forum, Element/Matrix chat or something for communication? HOT 6
- What exactly guarantees that all of the produced codes have exactly the same behavior? HOT 7
- syntactic sugar for getters/setters HOT 1
- Duplicated symbol error reported on wrong line HOT 1
- false positive error inside #if condition? HOT 1
- Transpiling to Dart
- Conditional compilation is broken HOT 2
- [Feature Request] Introduce size_t type to language HOT 3
- [Proposal] Allow flag usage in native blocks HOT 9
- Unable to use "native" inside of class but outside of function HOT 5
- [Bug] "native" blocks outside of class inject code in wrong place HOT 4
- Add some basic examples and or syntax documentation HOT 2
- [Proposal] Allow writing code without OOP 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 fut.