https://linen.dev logo
Powered by
# haxe-ui
  • b
    Im not the main person that reads that code so hurting readability is a no-go
  • b
    i mean i have no issue reading sources ... but frankly a helpful comment here and there is sometimes more helpful than a need to post in a forum
  • b
    i dont think huge doc comments bother most people, at least ive never heard anyone else complain about it
  • b
    I think it's the online code that's kinda uncomfortable
  • b
    Because ppl think they can sacrifice code readability and just write some inline docs
  • b
    yeah, i mean, docs are important i think for most people - personally i tend to just read the source, it seems quicker, but i get that im in the minority... and it also depends on the source ofc
  • b
    so times a "this does this" is easier than having to follow "x"
  • b
    even with the camel3 / karaf / amq libs, i tend to just read the decompiled source code... i just seems frankly easier to follow
  • b
    Which most of the time aren't very helpful:
    Copy code
    haxe
//assigning a variable a2fb to a utf8 representation of strf(s)
Var a2fb = strf(s).utf8();
    šŸ‘† this shit is W A Y too common
  • b
    yeah, i mean thats defo useless
  • b
    and i would argue this is verbosity to the max:
  • b
    Copy code
    /**
        The growth in pixels on the right side of the target object.
        The growth is the area beyond the bounds of the target object that is
        passed to the shader during execution. At execution time Flash Player
        or AIR computes the normal bounds of a movie clip and extends the
        bounds based on the `leftExtension`, `rightExtension`, `topExtension`,
        and `bottomExtension` values.
        @default 0
    **/
    public var rightExtension:Int;
  • b
    it could just be 
    The growth in pixels on the right side of the target object.
  • b
    but then i would argue what is the comment even adding
  • b
    i guess its just for doc gen
  • b
    I think openfl is a special case tho, because it tries to make moving from flash to haxe as easy as possible, and it tries to imitate flash
  • b
    So it also copies irs documentation
  • b
    im not really talking about openfl specifically, i just mean these type of doc comments
  • b
    Oh ok
  • b
    public var rightExtension:Int = 0; // growth in pixels on the right side of the target object
  • b
    Seeing flash air automatically made openfl pop up lol
  • b
    seems far more sensible, but i still dont really get what the comment adds
  • b
    instead of this comment i would prefer a picture instead
  • b
    The inline one is just kinda useless at this point
  • b
    yeah, i think thats my pet peeve, that we put documentation in the source, and its just bloat (usually)
  • b
    its so that we can use doc gen and avoid drift
  • b
    Might as well just:
    Copy code
    haxe
/** growth in pixels on the right side of the target object */ public var rightExtention:Int;
  • b
    Iline documentation;you're welcome
  • b
    Yes it shows up like regular docs
  • b
    yeah, there is no good solution i guess, but the (seemingly) agreed upon solution is writing comments in source so we can generate "documents" from them... which seems (to me at least) as using source files wrong
1...100410051006...1687Latest