জুলিয়া আরপিএলে কীভাবে ব্যবহারকারীর সংজ্ঞায়িত ফাংশন বিবরণ ("ডকাস্ট্রিংস") করা যায়?

Question

কিভাবে ব্যবহারকারী করতে পারেন সংজ্ঞায়িত ফাংশন (বলুন f) অর্থপূর্ণ প্রিন্টআউটগুলি আছে REPL ব্যবহার মাধ্যমে পরিদর্শন ?fবাhelp(f)

উদাহরণস্বরূপ কল্পনা করুন আমি নিম্নলিখিত ফানসিটন লিখি

function f(x::Float64, y::Float64)
    return 2x - y^2
end

আমি যদি এটি জুলিয়া সেশনে লোড করি এবং চেষ্টা help(f)করি তবে নিম্নলিখিতগুলি পান:

julia> help(f)
f (generic function with 1 method)

পরিবর্তে যদি আমি কিছু দেখতে চাই

julia> help(f)
f

   Compute 2 times x minus y squared

যেখানে "কোষে 2 বার x মাইনাস y স্কোয়ার্ড" বিবরণ লেখা হয়েছে। আমি অনুমান করছি আমার প্রশ্নের উত্তরটি প্রশ্নের উত্তর থেকে নির্ধারণ করা যেতে পারে "কোথা থেকে কোথায় বিবরণটি লেখা উচিত?"

---

উদাহরণস্বরূপ, যদি আমি পাইথনে একই কাজ করতে চাই, আমি ফাংশনটি সংজ্ঞায়িত করতে এবং বর্ণনাকে একটি ডাস্ট্রিং হিসাবে রাখতে পারি:

def f(x, y):
    """
    Compute 2 times x minus y squared
    """
    return 2 *  x - y ** 2

যা আমি টাইপ করার সময় help(f)বা f?আইপিথন থেকে আমার বিবরণটি অবিলম্বে উপলব্ধ করে তুলব ।

Comments

আমি মনে করি না আপনি এখনও এটি করতে পারেন। উদাহরণস্বরূপ দেখুন: github.com/JuliaLang/julia/issues/3988

— ivarne

এটি শীঘ্রই ঘটবে। এখানে

— spencerlyon2

Answer 1

আপনি @docজুলিয়া সংস্করণ 0.4 (অক্টোবর 2015) এবং তারপরে ম্যাক্রো ব্যবহার করতে পারেন ।

% julia
               _
   _       _ _(_)_     |  A fresh approach to technical computing
  (_)     | (_) (_)    |  Documentation: http://docs.julialang.org
   _ _   _| |_  __ _   |  Type "?help" for help.
  | | | | | | |/ _` |  |
  | | |_| | | | (_| |  |  Version 0.4.0 (2015-10-08 06:20 UTC)
 _/ |\__'_|_|_|\__'_|  |  Official http://julialang.org/ release
|__/                   |  x86_64-apple-darwin13.4.0

julia> @doc """
       Compute 2 times x minus y squared.
       """ ->
       function f(x::Float64, y::Float64)
           return 2x - y^2
       end
f (generic function with 1 method)

julia> @doc f
  Compute 2 times x minus y squared.

সম্পাদনা: @ হ্যারিসন গ্রোডিনের নির্দেশ অনুসারে, ০.০ বা তার বেশি সংস্করণগুলি সংক্ষিপ্ত বাক্য গঠন পাশাপাশি মার্কডাউন, ল্যাটেক্স এবং আরও কয়েকটি গুডিকে সমর্থন করে:

"""
Calculate the left Riemann sum[^1] approximating ``\int_a^b f(x) dx = F(b) - F(a).``

[^1]: Thomas G., Finney R. (1996), Calculus and Analytic Geometry, Addison Wesley, ISBN 0-201-53174-7
"""
function rs(a, b, d, f)
end

ডকুমেন্টেশনে আরও বিশদ রয়েছে ।

Answer 2

জুলিয়া v0.5 + তে ( 1.2+ এর মতো আরও সাম্প্রতিক জুলিয়া সংস্করণ সহ ) আপনি ফাংশন সংজ্ঞাটির উপরে একাধিক রেখা লিখতে পারেন। (আর দরকার @docনেই।)

julia> """
           cube(x)

       Compute the cube of `x`, ``x^3``.

       # Examples
       ```jldoctest
       julia> cube(2)
       8
       ```
       """
       function cube(x)
           x^3
       end
cube

help?> cube
search: Cdouble isexecutable Ac_mul_B Ac_mul_Bc Ac_mul_B! Ac_mul_Bc! cumsum_kbn

  cube(x)

  Compute the cube of x, x^3.

     Examples
    ≡≡≡≡≡≡≡≡≡≡

  julia> cube(2)
  8

আপনার ডকাস্ট্রিংগুলিকে সঠিকভাবে ফর্ম্যাট করার বিষয়ে আরও তথ্যের জন্য, সরকারী জুলিয়া ডকুমেন্টেশন দেখুন ।