Nei miei exploit di scripting, controllo spesso per vedere se uno script è stato scritto in precedenza prima di iniziare da zero. Spesso riesco almeno a trovare qualcosa di cui ho bisogno attraverso google o altri mezzi. Quindi adattare ciò che trovo ai miei bisogni e metterlo in produzione. Come best practice, commento il mio codice e includo le informazioni dell'autore (non sono un fan del plagio). Tuttavia, diventa la questione di come e quando è opportuno aggiungere/modificare la designazione dell'autore. Userò uno script di esempio da Ed Wilson il suo blog per riferimento:Qual è il modo corretto di condividere il credito per l'authoring e l'editing di script?
Function Get-OutlookCalendar {
<#
.Synopsis
This function returns appointment items from default Outlook profile
.Description
This function returns appointment items from default Outlook profile. It
uses the Outlook interop assembly to use the olFolderCalendar enumeration.
It creates a custom object consisting of Subject, Start, Duration, Location
for each appointment item.
.Example
Get-OutlookCalendar |
where-object { $_.start -gt [datetime]"5/10/2011" -AND $_.start -lt `
[datetime]"5/17/2011" } | sort-object Duration
Displays subject, start, duration and location for all appointments that
occur between 5/10/11 and 5/17/11 and sorts by duration of the appointment.
The sort is shortest appointment on top.
.Notes
NAME: Get-OutlookCalendar
AUTHOR: ed wilson, msft
LASTEDIT: 05/10/2011 08:36:42
KEYWORDS: Microsoft Outlook, Office
HSG: HSG-05-24-2011
.Link
Http://www.ScriptingGuys.com/blog
#Requires -Version 2.0
#>
Add-Type -AssemblyName "Microsoft.Office.Interop.Outlook" | Out-Null
$olFolders = "Microsoft.Office.Interop.Outlook.OlDefaultFolders" -as [type]
$outlook = New-Object -ComObject Outlook.Application
$namespace = $outlook.GetNameSpace("MAPI")
$folder = $namespace.getDefaultFolder($olFolders::olFolderCalendar)
$folder.items |
Select-Object -Property Subject,Start,Duration,Location
}
ho visualizzare il campo autore come il punto di contatto per lo script in quanto è la persona che lo ha scritto e la comprende. C'è una regola generale su quanto viene modificato uno script prima che non abbia più senso elencare l'autore originale? O sono sempre l'autore e poi sei un editore?
Nel caso di quest'ultimo, qual è il modo appropriato per designarlo? È che si aggiunge una riga sotto Autore etichettato "Editor" e si modifica l'ultima etichetta di modifica? Qual è esattamente il modo giusto per documentare i tuoi contributi? Esiste una best practice documentata?
Praticamente ogni volta che prendo il codice da .net, inserisco una descrizione in alto con un collegamento all'originale insieme al nome dell'autore originale. Poi inserirò una breve descrizione di ciò che ho cambiato, se non altro per esattamente le stesse ragioni. – NotMe