2016-05-04 7 views
1

Ich benutze Kotlin, um Android-App zu entwickeln. Wir wissen, dass Kotlin Markdown verwendet, um seinen Code zu dokumentieren. Also versuche ich, ein Flussdiagramm von Abschlag Syntax zu ziehen, wie unten:Kotlin-Datei unterstützt kein Flussdiagramm von Markdown geschrieben?

/** 
* Created by zhangruofan on 16-3-2. 
* 
* ```flow 
* st=>start: Start|past:>http://www.google.com[blank] 
* e=>end: End:>http://www.google.com 
* op1=>operation: My Operation|past 
* op2=>operation: Stuff|current 
* sub1=>subroutine: My Subroutine|invalid 
* cond=>condition: Yes 
* or No?|approved:>http://www.baidu.com 
* c2=>condition: Good idea|rejected 
* io=>inputoutput: catch something...|request 
* 
* st->op1(right)->cond 
* cond(yes, right)->c2 
* cond(no)->sub1(left)->op1 
* c2(yes)->io->e 
* c2(no)->op2->e 
* ``` 
*/ 

aber das Flussdiagramm nicht andere Abschlag Syntax nicht show.Some wie **Bold** funktionierts. Ich weiß nicht, wie ich es zum Laufen bringen soll.

+2

Flussdiagramm ist keine Konstruktion, die der Markdown-Syntax inhärent ist, wie '* bold *' ist. Bitte erklären Sie, warum Sie erwarten, dass es unterstützt wird? – Ilya

+0

Ich möchte das Diagramm verwenden, um die Struktur meiner Klasse zu zeigen. Wenn die Leute einen Blick auf die Klasse werfen, können sie einen klaren Eindruck davon haben. –

Antwort

1

Wie Ilya sagte, Markdown hat keine Unterstützung für die Erstellung von Ablaufdiagrammen. Was Sie tun, ist Abzählen (in diesem Fall speziell GitHub Flavored Markdown), um vorformatierten Text zu rendern und ihn entsprechend der Syntax der Sprache flow hervorzuheben.

Wenn Sie eine Umgebung haben, in der der obige Code ein Diagramm anzeigt, handelt es sich um benutzerdefinierte Funktionen in dieser Umgebung, die Sie nirgendwo anders erwarten sollten.

Die Abschrift, die Kotlin unterstützt, ist (im Grunde vanilla markdown mit einigen Erweiterungen für die Verknüpfung mit verschiedenen Bits des Codes).

+1

Haben Sie aus reiner Neugier eine Umgebung, in der dieser Ausschnitt tatsächlich ein Diagramm darstellen würde? –

+0

Ich verwende 'Cmd MarkDown', die Flowchart-Syntax funktioniert darauf. –

+0

Das ist interessant. Das habe ich noch nie zuvor gesehen. Aber es hat eine Reihe von Erweiterungen, die normale Abschriften nicht bieten (wie die Diagramm- und Mathe-Syntax). Kotlin unterstützt mehr Vanilla Markdown. Siehe https://kotlinlang.org/docs/reference/kotlin-doc.html –

Verwandte Themen