Как указано в Справочнике по форматированию разметки , вы можете использовать символы *
, +
или -
в качестве префиксов для ключевых слов разметки. Например, взгляните на Parameter
:
Теперь, когда я пытаюсь использовать *
, разметка не работает:
/**
* Parameter piece: A piece to validate.
* Parameter matchBlock: Called only if necessary.
*/
init(piece: MSPiece?, matchBlock: MatchBlock) { ... }
Приведенный выше код приводит к:
Но если мы поставим +
или -
вместо *
,
/**
+ Parameter piece: A piece to validate.
- Parameter matchBlock: Called only if necessary.
*/
init(piece: MSPiece?, matchBlock: MatchBlock) { ... }
Документация будет правильной:
Почему не *
не работает? Было бы здорово использовать звездочку, потому что /** */
комментирует статистику и заканчивается звездочкой, и это будет действительно аккуратно.