MATLAB Language
दस्तावेज़ीकरण कार्य

टिप्पणियों

सरल कार्य प्रलेखन

function output = mymult(a, b)
% MYMULT Multiply two numbers.
%   output = MYMULT(a, b) multiplies a and b.
%
%   See also fft, foo, sin.
%
%   For more information, see <a href="matlab:web('https://google.com')">Google</a>.
    output = a * b;
end

help mymult :

mymult दो संख्याओं को गुणा करें।

output = mymult (a, b) गुणा a और b करता है।

यह भी देखें fft, foo, sin

अधिक जानकारी के लिए, Google देखें।

fft और sin स्वचालित रूप से अपने संबंधित सहायता पाठ से लिंक करते हैं, और Google google.com का लिंक है। foo इस मामले में किसी भी डॉक्यूमेंटेशन से लिंक नहीं करेगा, क्योंकि जब तक सर्च पाथ पर foo के नाम से डॉक्यूमेंटेड फंक्शन / क्लास नहीं है।

स्थानीय समारोह प्रलेखन

इस उदाहरण में, स्थानीय फ़ंक्शन baz ( foo.m में परिभाषित) के लिए प्रलेखन या तो help foo में परिणामी लिंक या सीधे help foo>baz माध्यम से पहुँचा जा सकता है।

function bar = foo
%This is documentation for FOO.
% See also foo>baz

% This wont be printed, because there is a line without % on it.
end

function baz
% This is documentation for BAZ.
end

एक फ़ंक्शन हस्ताक्षर प्राप्त करना

MATLAB को किसी फ़ंक्शन की 1 ^सेंट लाइन प्रिंट करना अक्सर सहायक होता है, क्योंकि इसमें इनपुट और आउटपुट सहित आमतौर पर फ़ंक्शन हस्ताक्षर होते हैं:

dbtype <functionName> 1

उदाहरण:

>> dbtype fit 1

1  function [fitobj,goodness,output,warnstr,errstr,convmsg] = fit(xdatain,ydatain,fittypeobj,varargin)

एक उदाहरण स्क्रिप्ट के साथ एक समारोह का दस्तावेजीकरण

किसी फंक्शन को डॉक्यूमेंट करने के लिए अक्सर एक उदाहरण स्क्रिप्ट की मदद मिलती है जो आपके फंक्शन का उपयोग करती है। तब Matlab में प्रकाशित फ़ंक्शन का उपयोग एम्बेडेड चित्रों, कोड, लिंक, आदि के साथ एक मदद फ़ाइल बनाने के लिए किया जा सकता है । आपके कोड को दस्तावेज करने के लिए सिंटैक्स यहां पाया जा सकता है ।

फ़ंक्शन यह फ़ंक्शन Matlab में "सही" FFT का उपयोग करता है।

function out_sig = myfft(in_sig)

out_sig = fftshift(fft(ifftshift(in_sig)));

end

उदाहरण स्क्रिप्ट यह एक अलग स्क्रिप्ट है जो इनपुट, आउटपुट को समझाती है, और एक उदाहरण देकर बताती है कि सुधार क्यों आवश्यक है। इस समारोह के मूल लेखक वू, कान के लिए धन्यवाद।

%% myfft
% This function uses the "proper" fft in matlab. Note that the fft needs to
% be multiplied by dt to have physical significance.
% For a full description of why the FFT should be taken like this, refer
% to: Why_use_fftshift(fft(fftshift(x)))__in_Matlab.pdf included in the
% help folder of this code. Additional information can be found:
% <https://www.mathworks.com/matlabcentral/fileexchange/25473-why-use-fftshift-fft-fftshift-x----in-matlab-instead-of-fft-x-->
%
%% Inputs
% *in_sig* - 1D signal
% 
%% Outputs
% *out_sig* - corrected FFT of *in_sig*
% 
%% Examples
% Generate a signal with an analytical solution. The analytical solution is
% then compared to the fft then to myfft. This example is a modified
% version given by Wu, Kan given in the link aboce.
%%
% Set parameters
fs = 500;           %sampling frequency
dt = 1/fs;          %time step
T=1;                %total time window
t = -T/2:dt:T/2-dt; %time grids
df = 1/T;           %freq step
Fmax = 1/2/dt;      %freq window
f=-Fmax:df:Fmax-df; %freq grids, not used in our examples, could be used by plot(f, X)
%%
% Generate Gaussian curve
Bx = 10; A = sqrt(log(2))/(2*pi*Bx);    %Characteristics of Gaussian curve
x = exp(-t.^2/2/A^2);                   %Create Gaussian Curve
%% 
% Generate Analytical solution
Xan = A*sqrt(2*pi)*exp(-2*pi^2*f.^2*A^2); %X(f), real part of the analytical Fourier transform of x(t)

%%
% Take FFT and corrected FFT then compare
Xfft = dt *fftshift(fft(x));    %FFT
Xfinal = dt * myfft(x);         %Corrected FFT
hold on
plot(f,Xan);
plot(f,real(Xfft));
plot(f,real(Xfinal),'ro');
title('Comparison of Corrected and Uncorrected FFT');
legend('Analytical Solution','Uncorrected FFT','Corrected FFT');
xlabel('Frequency'); ylabel('Amplitude');
DT = max(f) - min(f);
xlim([-DT/4,DT/4]);

आउटपुट प्रकाशित विकल्प "प्रकाशित करें" टैब के तहत पाया जा सकता है, जो नीचे दिए गए छवि सरल फ़ंक्शन दस्तावेज़ीकरण में हाइलाइट किया गया है।

मतलाब स्क्रिप्ट को चलाएगा, और प्रदर्शित की जाने वाली छवियों को बचाएगा, साथ ही कमांड लाइन द्वारा उत्पन्न पाठ। आउटपुट को HTML, लेटेक्स और पीडीएफ सहित कई अलग-अलग प्रकार के प्रारूपों में सहेजा जा सकता है।

ऊपर दी गई उदाहरण स्क्रिप्ट का आउटपुट नीचे दी गई छवि में देखा जा सकता है।