Git Product home page Git Product logo

Comments (5)

SevInf avatar SevInf commented on September 8, 2024 1

I think this is consistent with pretty much any doc-comment systems out there? Putting empty line after a comment would detach it from the thing it used to document in JavaDoc, JSDoc/TSDoc, rust doc comments, as far as I am aware.

from prisma-engines.

javacode123 avatar javacode123 commented on September 8, 2024 1

That sounds dangerous. If I just want to take a note in the middle of the file, when using a /// it would then get attached magically to the next block/model instead of just floating, wouldn't it? What is the benefit of this behavior?

Okay, you convinced me.

from prisma-engines.

javacode123 avatar javacode123 commented on September 8, 2024

when there is an empty line between the comment and model, can not get documentation image i wan to know why do not process empty line. THX https://github.com/prisma/prisma-engines/blob/main/psl/schema-ast/src/parser/parse_schema.rs#L54
maybe this is better?
image

from prisma-engines.

javacode123 avatar javacode123 commented on September 8, 2024

I think this is consistent with pretty much any doc-comment systems out there? Putting empty line after a comment would detach it from the thing it used to document in JavaDoc, JSDoc/TSDoc, rust doc comments, as far as I am aware.

it seems that rust doc comments will work when there is space line

/// commnet A

pub struct A {}

截屏2023-11-27 19 47 52

from prisma-engines.

janpio avatar janpio commented on September 8, 2024

That sounds dangerous. If I just want to take a note in the middle of the file, when using a /// it would then get attached magically to the next block/model instead of just floating, wouldn't it? What is the benefit of this behavior?

from prisma-engines.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.